summary refs log tree commit diff
diff options
context:
space:
mode:
authorAmber Brown <hawkowl@atleastfornow.net>2018-08-17 22:31:02 +1000
committerGitHub <noreply@github.com>2018-08-17 22:31:02 +1000
commitfa27073b14a01fd4c472efb479e05f67839c0510 (patch)
tree64c6c944f17a8f07a425246a9e8737d3dd0622b0
parentMerge pull request #3705 from matrix-org/erikj/fix_inbound_fed_worker (diff)
parentCreate 3712.misc (diff)
downloadsynapse-fa27073b14a01fd4c472efb479e05f67839c0510.tar.xz
Merge pull request #3712 from matrix-org/travis/register-admin-docs
Update the admin register documentation to return a real user ID
-rw-r--r--changelog.d/3712.misc1
-rw-r--r--docs/admin_api/register_api.rst2
2 files changed, 2 insertions, 1 deletions
diff --git a/changelog.d/3712.misc b/changelog.d/3712.misc
new file mode 100644
index 0000000000..30f8c2af21
--- /dev/null
+++ b/changelog.d/3712.misc
@@ -0,0 +1 @@
+Update admin register API documentation to reference a real user ID.
diff --git a/docs/admin_api/register_api.rst b/docs/admin_api/register_api.rst
index 209cd140fd..16d65c86b3 100644
--- a/docs/admin_api/register_api.rst
+++ b/docs/admin_api/register_api.rst
@@ -33,7 +33,7 @@ As an example::
 
   < {
      "access_token": "token_here",
-     "user_id": "@pepper_roni@test",
+     "user_id": "@pepper_roni:localhost",
      "home_server": "test",
      "device_id": "device_id_here"
     }