summary refs log tree commit diff
diff options
context:
space:
mode:
authorStanislav Motylkov <x86corez@gmail.com>2021-11-10 00:11:05 +0300
committerGitHub <noreply@github.com>2021-11-09 21:11:05 +0000
commitb09d90cac9179f84024d4cb3ab4574480c1fd1df (patch)
tree2376f373326366ed0321a485db3bdd2b97bba35e
parentSplit out federated PDU retrieval into a non-cached version (#11242) (diff)
downloadsynapse-b09d90cac9179f84024d4cb3ab4574480c1fd1df.tar.xz
Fix typos in the `username_available` admin API documentation. (#11286)
-rw-r--r--changelog.d/11286.doc1
-rw-r--r--docs/admin_api/user_admin_api.md2
2 files changed, 2 insertions, 1 deletions
diff --git a/changelog.d/11286.doc b/changelog.d/11286.doc
new file mode 100644
index 0000000000..890d7b4ee4
--- /dev/null
+++ b/changelog.d/11286.doc
@@ -0,0 +1 @@
+Fix typo in the word `available` and fix HTTP method (should be `GET`) for the `username_available` admin API. Contributed by Stanislav Motylkov.
diff --git a/docs/admin_api/user_admin_api.md b/docs/admin_api/user_admin_api.md
index f03539c9f0..16ec33b3c1 100644
--- a/docs/admin_api/user_admin_api.md
+++ b/docs/admin_api/user_admin_api.md
@@ -1107,7 +1107,7 @@ This endpoint will work even if registration is disabled on the server, unlike
 The API is:
 
 ```
-POST /_synapse/admin/v1/username_availabile?username=$localpart
+GET /_synapse/admin/v1/username_available?username=$localpart
 ```
 
 The request and response format is the same as the [/_matrix/client/r0/register/available](https://matrix.org/docs/spec/client_server/r0.6.0#get-matrix-client-r0-register-available) API.