Versioning
The version is in the path: /integration/v1/.
Changes within v1
Within v1, changes are additive:
- responses can gain fields,
- enums can gain values,
- new operations and optional parameters can appear.
Ignore any field or value you do not recognise, so these additions never break your integration.
A change that could break an existing integration, such as removing or renaming a field, comes in a new major version with a new path.
The exception is the period before general availability. Until then, a breaking change can still land in v1. Each one is marked Breaking in the Changelog.
Announcements
Every addition, deprecation and removal is listed in the Changelog.