From ecae6b2d3895dca505e45f55da869d327a1dd794 Mon Sep 17 00:00:00 2001 From: Will Hunt Date: Mon, 4 Mar 2024 16:22:06 +0000 Subject: [PATCH] Add Retry-After header notice. --- content/client-server-api/_index.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/content/client-server-api/_index.md b/content/client-server-api/_index.md index 0e7e8473..51f81595 100644 --- a/content/client-server-api/_index.md +++ b/content/client-server-api/_index.md @@ -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 requirements for server responses. + ### Standard error response 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 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 are parts of the Client-Server API which are not universal to