Versioning and compatibility

The public Partner API starts at 1.0.0 and follows Semantic Versioning. OpenAPI.info.version, the changelog, version selector and immutable download artifacts always refer to the same contract version.

Allowed changes

• Patch releases correct the contract compatibly without introducing Partner API operations.
• Minor releases add compatible functionality. New operations require at least a minor release.
• Major releases contain incompatible changes and use a new URL namespace such as /api/v2/; /api/v1/ is never silently broken.
• Editorial guide changes do not change the contract version.

Before a major version, we publish a migration guide and contractual support end. Retirement never follows solely from releasing v2.