Versioning
The version is part of every path: today’s API is https://api.cedr.dev/v1. The address will not change; a future version would sit beside it at /v2, and /v1 would keep working while you move.
Changes Within v1
Section titled “Changes Within v1”These can happen at any time, so write clients that tolerate them:
- New endpoints.
- New optional request fields and new response fields.
- New
errorcodes for new problems. - Changes to the wording of
message.
Changes That Need a New Version
Section titled “Changes That Need a New Version”Removing or renaming an endpoint or field, changing a field’s type or meaning, and changing an existing error code only happen in a new version.