Concepts

Compatibility

We extend v1 over time without announcing each change. None of these changes will break a client that follows the rules on this page.

Additive changes

New endpoints, response fields and enum values can appear at any time. Ignore fields you don’t use, and don’t reject a response because it contains something you didn’t expect.

Enums

The reference lists the current values for each status and type field, but the lists can grow. Every switch on one of these fields needs a default branch.

Breaking changes

Removing or renaming a field, or changing what it means, is a breaking change. Those go into a new version with its own path, announced in advance, and v1 stays as it is.