Add Retry-After header notice.

This commit is contained in:
Will Hunt 2024-03-04 16:22:06 +00:00
parent 4e1b364015
commit ecae6b2d38

View file

@ -42,6 +42,7 @@ in the Appendices for conventions which all Matrix APIs are expected to follow,
and [Web Browser Clients](#web-browser-clients) below for additional and [Web Browser Clients](#web-browser-clients) below for additional
requirements for server responses. requirements for server responses.
### Standard error response ### Standard error response
Any errors which occur at the Matrix API level MUST return a "standard Any errors which occur at the Matrix API level MUST return a "standard
@ -2540,6 +2541,9 @@ return a standard error response of the form:
The `retry_after_ms` key SHOULD be included to tell the client how long The `retry_after_ms` key SHOULD be included to tell the client how long
they have to wait in milliseconds before they can try again. they have to wait in milliseconds before they can try again.
The `Retry-After` HTTP header MAY be specified by the server. When this header
is set, it SHOULD be preferred by clients over the `retry_after_ms` value.
## Modules ## Modules
Modules are parts of the Client-Server API which are not universal to Modules are parts of the Client-Server API which are not universal to