Skip to content

Commit

Permalink
Reword exceptions list
Browse files Browse the repository at this point in the history
  • Loading branch information
reivilibre committed Jun 5, 2024
1 parent a171b91 commit b242d4b
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions content/client-server-api/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,20 @@ recommended outside test environments.
Clients are authenticated using opaque `access_token` strings (see [Client
Authentication](#client-authentication) for details).

All `POST` and `PUT` endpoints, with the exception of [`POST
/_matrix/media/v3/upload`](#post_matrixmediav3upload), [`PUT
/_matrix/media/v3/upload/{serverName}/{mediaId}`](#put_matrixmediav3uploadservernamemediaid)
and [`POST /_matrix/client/v3/logout`](#post_matrixclientv3logout),
All `POST` and `PUT` endpoints, with the exception of those listed below,
require the client to supply a request body containing a (potentially empty)
JSON object. Clients should supply a `Content-Type` header of
`application/json` for all requests with JSON bodies, but this is not required.

The exceptions are:

- [`POST /_matrix/media/v3/upload`](#post_matrixmediav3upload),
which takes any type of request body depending on what type of media is to be uploaded.
- [`PUT /_matrix/media/v3/upload/{serverName}/{mediaId}`](#put_matrixmediav3uploadservernamemediaid),
which takes any type of request body depending on what type of media is to be uploaded.
- [`POST /_matrix/client/v3/logout`](#post_matrixclientv3logout),
which does not take any request body.

Similarly, all endpoints require the server to return a JSON object,
with the exception of 200 responses to
[`GET /_matrix/media/v3/download/{serverName}/{mediaId}`](#get_matrixmediav3downloadservernamemediaid)
Expand Down

0 comments on commit b242d4b

Please sign in to comment.