Skip to content
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

MSC2320: Versions information for identity servers #2320

Merged
merged 6 commits into from
Mar 21, 2021
Merged

MSC2320: Versions information for identity servers #2320

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ba88805
Proposal for versions information on the identity server API
babolivier Oct 15, 2019
6bd2876
MSC number
babolivier Oct 15, 2019
4517506
Incorporate review
babolivier Oct 15, 2019
52cd69e
Split into two non-versioned endpoints
babolivier Nov 7, 2019
0d4e2e7
Remove unstable_features endpoint
babolivier Feb 5, 2020
3c49ba9
Remove reference to second endpoint
babolivier Feb 5, 2020
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
35 changes: 35 additions & 0 deletions proposals/2320-identity-versions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Versions information for identity servers

The client-server API currently specifies a `/versions` endpoint that allows
clients to know what version of that API are implemented by the server.
Identity servers could benefit from that endpoint as both homeservers and
clients interact with them, and therefore could know which features they can
expect a given identity server to implement by looking at the versions of the
API it claims to support.

## Proposal

This proposal adds the following endpoint to the identity server API.

### `GET /_matrix/identity/versions`

This endpoint serves information about the versions of the identity server API
this identity server supports. Its response uses the following format:

```json
{
"versions": [
turt2live marked this conversation as resolved.
Show resolved Hide resolved
"r0.1.0",
"r0.2.0",
"r0.2.1",
]
}
```

## Alternative solutions

Another solution which was considered was using the status check endpoint ([`GET
/_matrix/api/v1`](https://matrix.org/docs/spec/identity_service/latest#get-matrix-identity-api-v1))
to serve this information. This solution was discarded because it's using a
versioned endpoint, which doesn't make sense to advertise the supported versions
of the API to use.