From 48184eefa3ec8d3233a6fa8a3b9fae2b85a7620a Mon Sep 17 00:00:00 2001 From: Ben Banfield-Zanin Date: Tue, 26 Aug 2025 09:04:47 +0100 Subject: [PATCH] Fix worker documentation around room Admin APIs (#18853) Discovered via https://github.com/element-hq/ess-helm/issues/677. Looking at https://github.com/element-hq/synapse/blob/v1.136.0/synapse/rest/admin/__init__.py#L266 only `RoomRestServlet` is generally worker capable. This is just the Room Details API and the v1 Room Delete API and not all the APIs documented on https://element-hq.github.io/synapse/latest/admin_api/rooms.html --- changelog.d/18853.doc.md | 1 + docs/workers.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 changelog.d/18853.doc.md diff --git a/changelog.d/18853.doc.md b/changelog.d/18853.doc.md new file mode 100644 index 000000000..4b0d1afed --- /dev/null +++ b/changelog.d/18853.doc.md @@ -0,0 +1 @@ +Fix worker documentation incorrectly indicating all room Admin API requests were capable of being handled by workers. diff --git a/docs/workers.md b/docs/workers.md index c275b4acd..18bb0b76f 100644 --- a/docs/workers.md +++ b/docs/workers.md @@ -252,7 +252,7 @@ information. ^/_matrix/client/(api/v1|r0|v3|unstable)/directory/room/.*$ ^/_matrix/client/(r0|v3|unstable)/capabilities$ ^/_matrix/client/(r0|v3|unstable)/notifications$ - ^/_synapse/admin/v1/rooms/ + ^/_synapse/admin/v1/rooms/[^/]+$ # Encryption requests ^/_matrix/client/(r0|v3|unstable)/keys/query$