Versioning and deprecation
The Map Studio API, the Tile API, and the Data API share one versioned contract, at version 0.7.0 today. REST paths start with /v1/, and the Data API has one endpoint, /graphql. The path stays the same as the contract evolves.
Below 1.0 there is no compatibility window. A minor release, such as 0.7 to 0.8, may remove or rename any operation, field, parameter, or enum value, and change any status. Nothing is deprecated before it is removed.
The changelog names each change. Read it before you upgrade an SDK.
From 1.0, an operation's name is frozen. Retiring one means three things:
- it is marked deprecated in the specification and in each SDK,
- its answers carry
DeprecationandSunsetheaders, - it keeps working for at least 180 days and two minor releases, then goes in the next major release.
@mountaya/client records the contract version it was generated from: