Every change to the /api/v1 surface is recorded here, newest first, with a date.
There are no entries yet
v1 has not gone generally available. No version of this API has served a production request, so there is nothing to have changed, and the first entry will be v1 GA on the day it happens.
A changelog whose only entry announced a release that has not occurred would be worse than an empty one: an integrator reading a dated GA line would reasonably conclude the API is live and start planning against it. The honest state is that the surface is built and tested and not released, and that is what the introduction says too.
What this page is not is a record of how the API was built. The commits, the internal plans and the corrections made before anybody could depend on them are not a public contract and belong nowhere near a document that integrators diff. This log starts at GA and covers only changes to a published surface.
What will appear here
Everything additive, which is to say everything that will ever happen to v1 without a version bump:
- a new endpoint
- a new optional field on a response
- a new optional request field or query filter
- a new value in an enum documented as extensible
- a new webhook event type
- a new error
code
Each entry will name the affected endpoints and say what you have to do, which for an additive change is normally nothing.
What will not appear here, because it cannot happen to v1
Removing or renaming a field, changing a field's type, making an optional request field required,
tightening validation, changing a status code, removing an endpoint, or changing what an existing field
means. Every one of those requires /api/v2, and v2 does not exist and is not planned.
If v2 ever ships, this page records the migration field by field, and v1 keeps running alongside it for at least twelve months from the v2 GA date. The full policy is on the introduction page.
Watching for changes
The reliable way to notice an additive change is to diff the OpenAPI document rather than to read this page. It is generated from the same definitions the routes are built from, so it moves in the same commit the behaviour does. This page is written by a person and is the explanation, not the source.
Businesses with a key used in the previous ninety days are emailed directly about anything that needs action from them. Nothing on this page will ever be the only warning you get about a breaking change, because there will not be a breaking change to warn about.