Note that /logout doesn't take a body (#1644)

pull/1506/merge
reivilibre 5 months ago committed by GitHub
parent 08bc8e8a1f
commit 2f528029c9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -0,0 +1 @@
Clarify specification by adding `/logout` to the overview list of endpoints that don't take a JSON request body.

@ -22,13 +22,20 @@ recommended outside test environments.
Clients are authenticated using opaque `access_token` strings (see [Client Clients are authenticated using opaque `access_token` strings (see [Client
Authentication](#client-authentication) for details). Authentication](#client-authentication) for details).
All `POST` and `PUT` endpoints, with the exception of [`POST All `POST` and `PUT` endpoints, with the exception of those listed below,
/_matrix/media/v3/upload`](#post_matrixmediav3upload) and [`PUT
/_matrix/media/v3/upload/{serverName}/{mediaId}`](#put_matrixmediav3uploadservernamemediaid),
require the client to supply a request body containing a (potentially empty) require the client to supply a request body containing a (potentially empty)
JSON object. Clients should supply a `Content-Type` header of JSON object. Clients should supply a `Content-Type` header of
`application/json` for all requests with JSON bodies, but this is not required. `application/json` for all requests with JSON bodies, but this is not required.
The exceptions are:
- [`POST /_matrix/media/v3/upload`](#post_matrixmediav3upload) and
[`PUT /_matrix/media/v3/upload/{serverName}/{mediaId}`](#put_matrixmediav3uploadservernamemediaid),
both of which take the uploaded media as the request body.
- [`POST /_matrix/client/v3/logout`](#post_matrixclientv3logout) and
[`POST /_matrix/client/v3/logout/all`](#post_matrixclientv3logoutall),
which take an empty request body.
Similarly, all endpoints require the server to return a JSON object, Similarly, all endpoints require the server to return a JSON object,
with the exception of 200 responses to with the exception of 200 responses to
[`GET /_matrix/media/v3/download/{serverName}/{mediaId}`](#get_matrixmediav3downloadservernamemediaid) [`GET /_matrix/media/v3/download/{serverName}/{mediaId}`](#get_matrixmediav3downloadservernamemediaid)

Loading…
Cancel
Save