Versioning

Use this policy to plan SDK and API upgrades.

Patch releases fix bugs while preserving valid public clients. Minor releases can add endpoints, optional fields, SDK helpers and CLI commands. Major releases can remove public fields or change required requests, call signatures or authentication semantics.

Additive response fields can appear in compatible releases. A removal or rename requires a new versioned contract path. Changes to request limits require release notes and migration guidance.

Deprecations

A deprecation identifies a replacement and the first deprecated release. Removal is targeted no earlier than the next minor release. HTTP deprecations include these headers:

Deprecation: true
Sunset: <RFC 9110 HTTP-date>

Next steps

• HTTP API
• Upgrade, back up and restore