Skip to main content

Versioning

The major version is part of every path: /api/v1/....

During the beta​

Operations can change in ways that break existing code.

After general availability​

/api/v1 changes only in ways that keep existing code working:

  • new operations
  • new optional request fields
  • new response fields
  • new values in existing enums

Write your code to ignore response fields it does not know, and to handle enum values it has not seen.

A breaking change ships as a new major version, such as /api/v2. The previous version stays available for at least 12 months after the new one is released.