From 47619017f97e04733e2a2fe511d6865d0294f063 Mon Sep 17 00:00:00 2001 From: Sami Olmari Date: Thu, 19 May 2022 14:03:12 +0300 Subject: [PATCH] Add missing user directory search endpoint to the generic worker documentation (#12773) Signed-off-by: Sami Olmari --- changelog.d/12773.doc | 1 + docs/workers.md | 10 ++++++++++ 2 files changed, 11 insertions(+) create mode 100644 changelog.d/12773.doc diff --git a/changelog.d/12773.doc b/changelog.d/12773.doc new file mode 100644 index 000000000..6de371653 --- /dev/null +++ b/changelog.d/12773.doc @@ -0,0 +1 @@ +Add missing user directory endpoint from the generic worker documentation. Contributed by @olmari. \ No newline at end of file diff --git a/docs/workers.md b/docs/workers.md index 553792d23..779069b81 100644 --- 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.