From f7cd91f6b0dc5e771ef01caf1680c4ab3a572fcc Mon Sep 17 00:00:00 2001 From: Ben Banfield-Zanin Date: Thu, 10 Sep 2026 17:25:24 +0100 Subject: [PATCH] Document that the new get single delayed event endpoint is workerisable (#20210) ### Pull Request Checklist Missed off of https://github.com/element-hq/synapse/pull/19926/changes IMO. My reading of https://github.com/element-hq/synapse/blob/v1.161.0rc1/synapse/rest/client/delayed_events.py is that the new endpoint (pattern `r"/org\.matrix\.msc4140/delayed_events/(?P[^/]+)$"` is workerisable) given how `register_servlets` flows. However given `UpdateDelayedEventServlet` covers the same pattern but for `POST` requests, this should go in the `GET` only part of the documentation. * [x] Pull request is based on the develop branch * [x] Pull request includes a [changelog file](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#changelog). The entry should: - Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from `EventStore` to `EventWorkerStore`.". - Use markdown where necessary, mostly for `code blocks`. - End with either a period (.) or an exclamation mark (!). - Start with a capital letter. - Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry. * [x] [Code style](https://element-hq.github.io/synapse/latest/code_style.html) is correct (run the [linters](https://element-hq.github.io/synapse/latest/development/contributing_guide.html#run-the-linters)) --- changelog.d/20210.doc | 1 + docs/workers.md | 3 +++ 2 files changed, 4 insertions(+) create mode 100644 changelog.d/20210.doc diff --git a/changelog.d/20210.doc b/changelog.d/20210.doc new file mode 100644 index 0000000000..3b0f828036 --- /dev/null +++ b/changelog.d/20210.doc @@ -0,0 +1 @@ +Document the endpoint for getting a single delayed event is workerisable. diff --git a/docs/workers.md b/docs/workers.md index 5914b9d1cb..5587ba9c6d 100644 --- a/docs/workers.md +++ b/docs/workers.md @@ -309,6 +309,9 @@ Additionally, the following REST endpoints can be handled for GET requests: # Admin API requests ^/_synapse/admin/v2/users/[^/]+$ + # Unstable MSC4140 support + ^/_matrix/client/unstable/org.matrix.msc4140/delayed_events/[^/]+$ + Pagination requests can also be handled, but all requests for a given room must be routed to the same instance. Additionally, care must be taken to ensure that the purge history admin API is not used while pagination requests