Add missing user directory search endpoint to the generic worker docu…

…mentation (#12773) Signed-off-by: Sami Olmari <[email protected]>
matrix-org · May 19, 2022 · 4761901 · 4761901
1 parent 5675ceb
commit 4761901
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/changelog.d/12773.doc b/changelog.d/12773.doc
@@ -0,0 +1 @@
+Add missing user directory endpoint from the generic worker documentation. Contributed by @olmari.
diff --git a/docs/workers.md b/docs/workers.md
@@ -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.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Add missing user directory endpoint from the generic worker documentation. Contributed by @olmari.