wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Remove unstable_features endpoint

Browse source
This commit is contained in:
Brendan Abolivier 2020-02-05 12:25:50 +00:00
parent 52cd69eb75
commit 0d4e2e75c7
No known key found for this signature in database
GPG key ID: 1E015C145F1916CD
1 changed files with 6 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,14 +1,11 @@
# Versions information for identity servers # Versions information for identity servers
The client-server API currently specifies a `/versions` endpoint that allows The client-server API currently specifies a `/versions` endpoint that allows
clients to know what version of that API and unstable features are implemented clients to know what version of that API are implemented by the server.
by the server. This allows MSC to be implemented and supported by both servers Identity servers could benefit from that endpoint as both homeservers and
and clients before they're merged and incorporated into the stable API. 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
This is also a feature we will need on the identity server API, because API it claims to support.
clients talk to them and need to be aware of unstables features (such as
[MSC2265](https://github.com/matrix-org/matrix-doc/pull/2265)) when they're
implemented by the identity server it's using (if there is one).
## Proposal ## Proposal
@ -29,26 +26,10 @@ this identity server supports. Its response uses the following format:
} }
``` ```
### `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 ## Alternative solutions
Another solution which was considered was using the status check endpoint ([`GET 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)) /_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 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 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 of the API to use.
the supported unstable features, whereas it makes more sense to have each of
these pieces of information served on a different endpoint.