Merge pull request #1097 from matrix-org/rav/deprecate_home_server

Mark `home_server` field deprecated

api/client-server/login.yaml

@@ -96,7 +96,6 @@ paths:
             application/json: {
                 "user_id": "@cheeky_monkey:matrix.org",
                 "access_token": "abc123",
-                "home_server": "matrix.org",
                 "device_id": "GHTYAJCE"
               }
           schema:
@@ -112,7 +111,13 @@ paths:
                   This access token can then be used to authorize other requests.
               home_server:
                 type: string
-                description: The hostname of the homeserver on which the account has been registered.
+                description: |-
+                  The server_name of the homeserver on which the account has
+                  been registered.
+
+                  **Deprecated**. Clients should extract the server_name from
+                  ``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: |-

api/client-server/registration.yaml

@@ -124,7 +124,6 @@ paths:
             application/json: {
                 "user_id": "@cheeky_monkey:matrix.org",
                 "access_token": "abc123",
-                "home_server": "matrix.org",
                 "device_id": "GHTYAJCE"
               }
           schema:
@@ -144,7 +143,13 @@ paths:
                   This access token can then be used to authorize other requests.
               home_server:
                 type: string
-                description: The hostname of the homeserver on which the account has been registered.
+                description: |-
+                  The server_name of the homeserver on which the account has
+                  been registered.
+
+                  **Deprecated**. Clients should extract the server_name from
+                  ``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: |-

changelogs/client_server.rst

@@ -1,7 +1,11 @@
 Unreleased changes
 ==================
 
-No changes as yet.
+- Spec clarifications:
+
+  - Mark ``home_server`` return field for ``/login`` and ``/register``
+    endpoints as deprecated
+    (`#1097 <https://github.com/matrix-org/matrix-doc/pull/1097>`_).
 
 r0.3.0
 ======