Mirrors
/
synapse-old
mirror of https://github.com/matrix-org/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add missing user directory search endpoint to the generic worker documentation (#12773) 

Signed-off-by: Sami Olmari <sami@olmari.fi>
This commit is contained in:
Sami Olmari 2022-05-19 14:03:12 +03:00 committed by GitHub
parent 5675cebfaa
commit 47619017f9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/12773.doc Normal file
View File

@ -0,0 +1 @@
Add missing user directory endpoint from the generic worker documentation. Contributed by @olmari.

10
docs/workers.md
View File

@ -251,6 +251,8 @@ information.
# Presence requests
^/_matrix/client/(api/v1|r0|v3|unstable)/presence/
# User directory search requests
^/_matrix/client/(r0|v3|unstable)/user_directory/search$
Additionally, the following REST endpoints can be handled for GET requests:
@ -448,6 +450,14 @@ update_user_directory_from_worker: worker_name
This work cannot be load-balanced; please ensure the main process is restarted
after setting this option in the shared configuration!
User directory updates allow REST endpoints matching the following regular
expressions to work:
^/_matrix/client/(r0|v3|unstable)/user_directory/search$
The above endpoints can be routed to any worker, though you may choose to route
it to the chosen user directory worker.
This style of configuration supersedes the legacy `synapse.app.user_dir`
worker application type.