Skip to content

Fix s2s versioning table #798

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
GarethCOliver wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix s2s versioning table #798

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b425183
Split API versioning table into request and response headers
GarethCOliver Aug 5, 2026
cfaede9
Fix header description for API versioning
GarethCOliver Aug 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions s2s/openid-4-verifiable-credential-issuance-server-2-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,12 +202,19 @@ All requests to endpoints MUST use HTTPS (TLS 1.2+) with mutual authentication.

The API uses header-based semantic versioning. The Client MUST include the desired API version in the `Api-Version` request header using the semantic version (e.g. `1.0.0`).

| **Header** | **Direction** | **Type** | **Description** |
|------------------------|---------------|-----------------------------------|---------------------------------------------------------------------------------------|
| Api-Version | Request | String (semantic version) | Required. Semantic version requested by the client (e.g., 1.0.0) |
| Api-Version | Response | String (semantic version) | Required. The version used to process the request |
| Api-Supported-Versions | Response | String (comma-separated versions) | Comma-separated list of versions the server supports |
| Sunset | Response | String (HTTP-date) | HTTP-date as defined in [@!RFC8594] after which the requested version will be removed |
The following header is used in requests to specify the desired API version:

| **Header** | **Type** | **Description** |
|------------------------|-----------------------------------|---------------------------------------------------------------------------------------|
| Api-Version | String (semantic version) | Required. Semantic version requested by the client (e.g., 1.0.0) |

The following headers are used in responses to convey information about the API version used or supported by the server:

| **Header** | **Type** | **Description** |
|------------------------|-----------------------------------|---------------------------------------------------------------------------------------|
| Api-Version | String (semantic version) | Required. The version used to process the request |
| Api-Supported-Versions | String (comma-separated versions) | Comma-separated list of versions the server supports |
| Sunset | String (HTTP-date) | HTTP-date as defined in [@!RFC8594] after which the requested version will be removed |

Server MUST reject requests with an unsupported `Api-Version` with HTTP 400 and a Problem Details response, indicating the supported versions in the header.

Expand Down
Loading