Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 2177e35

Browse files
authored
Sync more worker regexes in the documentation. (#12243)
1 parent c46065f commit 2177e35

File tree

2 files changed

+15
-16
lines changed

2 files changed

+15
-16
lines changed

changelog.d/12243.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Remove incorrect prefixes in the worker documentation for some endpoints.

docs/workers.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -185,8 +185,8 @@ worker: refer to the [stream writers](#stream-writers) section below for further
185185
information.
186186

187187
# Sync requests
188-
^/_matrix/client/(v2_alpha|r0|v3)/sync$
189-
^/_matrix/client/(api/v1|v2_alpha|r0|v3)/events$
188+
^/_matrix/client/(r0|v3)/sync$
189+
^/_matrix/client/(api/v1|r0|v3)/events$
190190
^/_matrix/client/(api/v1|r0|v3)/initialSync$
191191
^/_matrix/client/(api/v1|r0|v3)/rooms/[^/]+/initialSync$
192192

@@ -200,13 +200,9 @@ information.
200200
^/_matrix/federation/v1/query/
201201
^/_matrix/federation/v1/make_join/
202202
^/_matrix/federation/v1/make_leave/
203-
^/_matrix/federation/v1/send_join/
204-
^/_matrix/federation/v2/send_join/
205-
^/_matrix/federation/v1/send_leave/
206-
^/_matrix/federation/v2/send_leave/
207-
^/_matrix/federation/v1/invite/
208-
^/_matrix/federation/v2/invite/
209-
^/_matrix/federation/v1/query_auth/
203+
^/_matrix/federation/(v1|v2)/send_join/
204+
^/_matrix/federation/(v1|v2)/send_leave/
205+
^/_matrix/federation/(v1|v2)/invite/
210206
^/_matrix/federation/v1/event_auth/
211207
^/_matrix/federation/v1/exchange_third_party_invite/
212208
^/_matrix/federation/v1/user/devices/
@@ -274,6 +270,8 @@ information.
274270
Additionally, the following REST endpoints can be handled for GET requests:
275271

276272
^/_matrix/federation/v1/groups/
273+
^/_matrix/client/(api/v1|r0|v3|unstable)/pushrules/
274+
^/_matrix/client/(r0|v3|unstable)/groups/
277275

278276
Pagination requests can also be handled, but all requests for a given
279277
room must be routed to the same instance. Additionally, care must be taken to
@@ -397,23 +395,23 @@ the stream writer for the `typing` stream:
397395
The following endpoints should be routed directly to the worker configured as
398396
the stream writer for the `to_device` stream:
399397

400-
^/_matrix/client/(api/v1|r0|v3|unstable)/sendToDevice/
398+
^/_matrix/client/(r0|v3|unstable)/sendToDevice/
401399

402400
##### The `account_data` stream
403401

404402
The following endpoints should be routed directly to the worker configured as
405403
the stream writer for the `account_data` stream:
406404

407-
^/_matrix/client/(api/v1|r0|v3|unstable)/.*/tags
408-
^/_matrix/client/(api/v1|r0|v3|unstable)/.*/account_data
405+
^/_matrix/client/(r0|v3|unstable)/.*/tags
406+
^/_matrix/client/(r0|v3|unstable)/.*/account_data
409407

410408
##### The `receipts` stream
411409

412410
The following endpoints should be routed directly to the worker configured as
413411
the stream writer for the `receipts` stream:
414412

415-
^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/receipt
416-
^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/read_markers
413+
^/_matrix/client/(r0|v3|unstable)/rooms/.*/receipt
414+
^/_matrix/client/(r0|v3|unstable)/rooms/.*/read_markers
417415

418416
##### The `presence` stream
419417

@@ -528,7 +526,7 @@ Note that if a reverse proxy is used , then `/_matrix/media/` must be routed for
528526
Handles searches in the user directory. It can handle REST endpoints matching
529527
the following regular expressions:
530528

531-
^/_matrix/client/(api/v1|r0|v3|unstable)/user_directory/search$
529+
^/_matrix/client/(r0|v3|unstable)/user_directory/search$
532530

533531
When using this worker you must also set `update_user_directory: False` in the
534532
shared configuration file to stop the main synapse running background
@@ -540,7 +538,7 @@ Proxies some frequently-requested client endpoints to add caching and remove
540538
load from the main synapse. It can handle REST endpoints matching the following
541539
regular expressions:
542540

543-
^/_matrix/client/(api/v1|r0|v3|unstable)/keys/upload
541+
^/_matrix/client/(r0|v3|unstable)/keys/upload
544542

545543
If `use_presence` is False in the homeserver config, it can also handle REST
546544
endpoints matching the following regular expressions:

0 commit comments

Comments
 (0)