Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-04-03 17:54:14 +02:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

With inline comments about keeping them ordered

Browse source
This commit is contained in:
Hugh Nimmo-Smith 2026-03-12 09:22:19 +00:00
parent 9d73c8d9a4
commit 5b443bcf94
2 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
content/client-server-api/_index.md
View file

@ -93,6 +93,8 @@ request being made was invalid.
These error codes can be returned by any API endpoint: These error codes can be returned by any API endpoint:
<!-- Please keep the error codes below in alphabetical order -->
`M_BAD_JSON` `M_BAD_JSON`
: Request contained valid JSON, but it was malformed in some way, e.g. : Request contained valid JSON, but it was malformed in some way, e.g.
missing required keys, invalid values for keys. missing required keys, invalid values for keys.
@ -181,12 +183,16 @@ code if the endpoint is implemented, but the incorrect HTTP method is used.
: The account has been [suspended](#account-suspension) and can only be used for : The account has been [suspended](#account-suspension) and can only be used for
limited actions at this time. limited actions at this time.
<!-- Please keep the error codes above in alphabetical order -->
#### Other error codes #### Other error codes
The following error codes are specific to certain endpoints. The following error codes are specific to certain endpoints.
<!-- TODO: move them to the endpoints that return them --> <!-- TODO: move them to the endpoints that return them -->
<!-- Please keep the error codes below in alphabetical order -->
`M_BAD_STATE` `M_BAD_STATE`
: The state change requested cannot be performed, such as attempting to : The state change requested cannot be performed, such as attempting to
unban a user who is not banned. unban a user who is not banned.
@ -270,6 +276,8 @@ for endpoints that prove authentication, such as [`/login`](#get_matrixclientv3l
`M_USER_IN_USE` `M_USER_IN_USE`
: Encountered when trying to register a user ID which has been taken. : Encountered when trying to register a user ID which has been taken.
<!-- Please keep the error codes above in alphabetical order -->
#### Rate limiting #### Rate limiting
Homeservers SHOULD implement rate limiting to reduce the risk of being Homeservers SHOULD implement rate limiting to reduce the risk of being

4
content/identity-service-api.md
View file

@ -70,6 +70,8 @@ the keys `error` and `errcode` MUST always be present.
Some standard error codes are below: Some standard error codes are below:
<!-- Please keep the error codes below in alphabetical order -->
`M_EMAIL_SEND_ERROR` `M_EMAIL_SEND_ERROR`
: There was an error sending an email. Typically seen when attempting to : There was an error sending an email. Typically seen when attempting to
verify ownership of a given email address. verify ownership of a given email address.
@ -119,6 +121,8 @@ This is expected to be returned with a 404 HTTP status code if the endpoint is
not implemented or a 405 HTTP status code if the endpoint is implemented, but not implemented or a 405 HTTP status code if the endpoint is implemented, but
the incorrect HTTP method is used. the incorrect HTTP method is used.
<!-- Please keep the error codes above in alphabetical order -->
## Privacy ## Privacy
Identity is a privacy-sensitive issue. While the identity server exists Identity is a privacy-sensitive issue. While the identity server exists