Skip to main content
The major API version is part of the base path. Version 1 operations use /v1.

​
Compatible changes

The following may be added within v1:
  • new optional response fields;
  • new endpoints;
  • new optional query parameters;
  • new documented enum members where clients are required to handle unknown values.
Existing field meaning or type will not be changed in place. Removing or renaming a field, changing required behavior, or otherwise breaking a conforming client requires a new major API path.

​
Pin the contract

Use the versioned OpenAPI document for client generation and validation:
The unversioned /openapi.yaml route is only a convenience alias for the current major version.