Changelog
Here, you can view a changelog of the major updates made to the API.
Grouping
We group changes within each date by category:
- 🚀 New Features represent a reverse-compatible, new feature for the API. These will be available to new users and can be added by existing users, without breaking existing usage. Examples include new endpoints or a new field being supported in an existing endpoint.
- ❌ Breaking Changes represent a change that may actively break features. These will be telegraphed weeks in advance (where possible) via a Deprecated header and have a pathway to migrate for zero downtime for your end users.
- 📉 Deprecated represents features we will remove at a future point (see "Breaking Changes") and will include an Service-Level Agreement (SLA) after which we will decomission the feature. If no SLA is provided, assume one month.
- 🐛 Bug Fixes represents user-visible bug fixes made to the API.
Our changelog includes only externally visible changes to the API. Bug fixes will be covered on a best-effort basis where relevant.
Breaking Changes
We'll send out emails whenever features are deprecated or breaking changes are planned. We want to give our users as much time to adjust things on their end while still enabling us to prototype quickly.
note
As this API is still in beta, these will be on a best-effort basis.