From 5721712eae1ea6e039d8452c5539bb08f358b76e Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Sun, 10 Feb 2019 17:47:17 -0700 Subject: [PATCH] Add M_RESOURCE_LIMIT_EXCEEDED Original proposal: https://github.com/matrix-org/matrix-doc/issues/1504 No changes from the original proposal or implementations have been made intentionally here. --- changelogs/client_server/newsfragments/1874.feature | 1 + specification/client_server_api.rst | 10 +++++++++- 2 files changed, 10 insertions(+), 1 deletion(-) create mode 100644 changelogs/client_server/newsfragments/1874.feature diff --git a/changelogs/client_server/newsfragments/1874.feature b/changelogs/client_server/newsfragments/1874.feature new file mode 100644 index 00000000..03b891e2 --- /dev/null +++ b/changelogs/client_server/newsfragments/1874.feature @@ -0,0 +1 @@ +Add `M_RESOURCE_LIMIT_EXCEEDED` as an error code for when homeservers exceed limits imposed on them. diff --git a/specification/client_server_api.rst b/specification/client_server_api.rst index b41c3460..618fdc10 100644 --- a/specification/client_server_api.rst +++ b/specification/client_server_api.rst @@ -210,10 +210,18 @@ Other error codes the client might encounter are: The resource being requested is reserved by an application service, or the application service making the request has not created the resource. +:``M_RESOURCE_LIMIT_EXCEEDED``: + The request cannot be completed because the homeserver has reached a resource + limit imposed on it. For example, a homeserver held in a shared hosting environment + may reach a resource limit if it starts using too much memory or disk space. The + error MUST have an ``admin_contact`` field to provide the user receiving the error + a place to reach out to. Typically, this error will appear on routes which attempt + to modify state (eg: sending messages, account data, etc) and not routes which only + read state (eg: ``/sync``, get account data, etc). + .. TODO: More error codes (covered by other issues) .. * M_CONSENT_NOT_GIVEN - GDPR: https://github.com/matrix-org/matrix-doc/issues/1512 .. * M_CANNOT_LEAVE_SERVER_NOTICE_ROOM - GDPR: https://github.com/matrix-org/matrix-doc/issues/1254 -.. * M_RESOURCE_LIMIT_EXCEEDED - Limits: https://github.com/matrix-org/matrix-doc/issues/1504 .. _sect:txn_ids: