From 5ea6d5610f6bb307f3b680ffd4a247868b65dc3a Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Tue, 26 Oct 2021 15:47:40 -0600 Subject: [PATCH] Update identity server spec to use global versioning (#3459) * Update identity server spec to use global versioning * changelog --- .../identity_service/newsfragments/3459.clarification | 1 + data/api/identity/versions.yaml | 6 ++++-- 2 files changed, 5 insertions(+), 2 deletions(-) create mode 100644 changelogs/identity_service/newsfragments/3459.clarification diff --git a/changelogs/identity_service/newsfragments/3459.clarification b/changelogs/identity_service/newsfragments/3459.clarification new file mode 100644 index 00000000..fd838ff6 --- /dev/null +++ b/changelogs/identity_service/newsfragments/3459.clarification @@ -0,0 +1 @@ +Describe how [MSC2844](https://github.com/matrix-org/matrix-doc/pull/2844) affects the `/versions` endpoint. diff --git a/data/api/identity/versions.yaml b/data/api/identity/versions.yaml index 51d6762c..ff821e22 100644 --- a/data/api/identity/versions.yaml +++ b/data/api/identity/versions.yaml @@ -29,7 +29,9 @@ paths: description: |- Gets the versions of the specification supported by the server. - Values will take the form `rX.Y.Z`. + Values will take the form `vX.Y` or `rX.Y.Z` in historical cases. See + [the Specification Versioning](../#specification-versions) for more + information. All supported versions, including patch versions, are reported by the server. operationId: getVersions @@ -38,7 +40,7 @@ paths: description: The versions supported by the server. examples: application/json: { - "versions": ["r0.1.0", "r0.2.0", "r0.2.1"] + "versions": ["r0.2.0", "r0.2.1", "v1.1"] } schema: type: object