Explain how to split an mxid

7 years ago · 00b28495a6
parent 6a524be585
commit 00b28495a6
2 changed files with 8 additions and 6 deletions
--- a/api/client-server/login.yaml
+++ b/api/client-server/login.yaml
@ -112,11 +112,12 @@ paths:
              home_server:
                type: string
                description: |-
-                  The server_name of the homeserver on which the account has been registered.
+                  The server_name of the homeserver on which the account has
+                  been registered.

                  **Deprecated**. Clients should extract the server_name from
-                  ``user_id`` if they require it. Note also that ``homeserver``
-                  is not spelt this way.
+                  ``user_id`` (by splitting at the first colon) if they require
+                  it. Note also that ``homeserver`` is not spelt this way.
              device_id:
                type: string
                description: |-
--- a/api/client-server/registration.yaml
+++ b/api/client-server/registration.yaml
@ -144,11 +144,12 @@ paths:
              home_server:
                type: string
                description: |-
-                  The server_name of the homeserver on which the account has been registered.
+                  The server_name of the homeserver on which the account has
+                  been registered.

                  **Deprecated**. Clients should extract the server_name from
-                  ``user_id`` if they require it. Note also that ``homeserver``
-                  is not spelt this way.
+                  ``user_id`` (by splitting at the first colon) if they require
+                  it. Note also that ``homeserver`` is not spelt this way.
              device_id:
                type: string
                description: |-