v2
v2 overview
Placeholder for v2 — unreleased, defining no endpoints yet; when a new version is introduced and how it relates to v1.
/v2 is not released; this page is a placeholder. No v2 endpoint is callable today — integrate against v1.
When a v2 would exist
Only breaking changes introduce a new version. Concretely:
- an existing field's semantics or required-ness must change;
- an existing endpoint's path, parameter location or response structure must change;
- the authentication method or audience split must change.
Changes that fit inside v1 (new endpoints, new optional fields, new error code values) do not create a v2.
What it will look like once released
The structure follows v1's four levels: version → context → endpoint group. This page will then be replaced by a real overview containing:
| Content | Notes |
|---|---|
| Context list | Which contexts v2 keeps, adds or merges |
| Differences from v1 | Breaking changes listed one by one, with migration steps |
| Parallel period | The window during which v1 and v2 coexist, and the retirement plan |
| Migration guide | Steps to move from v1 to v2 and how to verify |
What to do now
- New integrations: implement against v1;
- Already on v1: nothing to prepare; v2's existence does not affect v1 behaviour;
- Tracking changes: advance notice of breaking changes appears on this page first, then moves into the real overview.