Versioning
Version 1 of the public API lives under /api/public/v1. This page states what may change inside it and how a change that would break your integration reaches you.
Additive inside a version
Section titled “Additive inside a version”Changes inside version 1 are additive only: new operations, new optional fields and new enum values. Build your integration to accept response fields and enum values it does not know.
A breaking change ships under a new namespace, /api/public/v2, alongside version 1, which keeps answering until its sunset date.
Deprecation
Section titled “Deprecation”An operation that is going away is first marked deprecated, at least 90 days before it is removed, or 30 days for an operation marked beta. From then on, each of its responses carries three headers:
| Header | Meaning |
|---|---|
Deprecation | When the operation was deprecated |
Sunset | When it stops answering |
Link | A link to this page, with rel="deprecation" |
The API changelog records every deprecation and every new operation.