Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-02-04 05:13:42 +01:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Split into two non-versioned endpoints

Browse source
This commit is contained in:
Brendan Abolivier 2019-11-07 15:45:58 +00:00
parent 4517506d57
commit 52cd69eb75
No known key found for this signature in database
GPG key ID: 1E015C145F1916CD
1 changed files with 26 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
proposals/2320-identity-versions.md
View file

@ -12,17 +12,15 @@ implemented by the identity server it's using (if there is one).
## Proposal
This proposal extends the [`/_matrix/identity/v2`](https://matrix.org/docs/spec/identity_service/r0.2.1#get-matrix-identity-api-v1)
endpoint's response by adding information about the supported versions of the
identity server API and unstable features implemented by the server
to it. Because the current response for this endpoint is an empty object
(which is discarded by the client), the new response would look like:
This proposal adds two endpoints 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
{
"unstable_features": {
"casefold_email_addresses": true
},
"versions": [
"r0.1.0",
"r0.2.0",
@ -31,12 +29,26 @@ to it. Because the current response for this endpoint is an empty object
}
```
This response would follow the format of the [`/_matrix/client/versions`](https://matrix.org/docs/spec/client_server/r0.5.0#get-matrix-client-versions) endpoint.
### `GET /_matrix/identity/unstable_features`
This endpoint serves information about the unstable features, i.e. features
specified in a MSC or an unstable version of the Matrix specification but not in
a stable one, supported by the server. Its response uses the following format:
```json
{
"unstable_features": {
"org.matrix.casefold_email_addresses": true
}
}
```
## Alternative solutions
An alternative solution to this issue would be to add a
`/_matrix/identity/versions` endpoint to the identity server API.
This would however add more complexity by adding a new endpoint whereas there's
already an existing endpoint which seems relevant for handling this kind of
information.
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, and this endpoint was serving both the supported versions and
the supported unstable features, whereas it makes more sense to have each of
these pieces of information served on a different endpoint.