Mark `home_server` field deprecated

This is spelt wrong, and is redundant to user_id, so let's stop people using
it.
pull/1097/head
Richard van der Hoff 7 years ago
parent f0f91bd9bc
commit d9a4ddbf65

@ -96,7 +96,6 @@ paths:
application/json: { application/json: {
"user_id": "@cheeky_monkey:matrix.org", "user_id": "@cheeky_monkey:matrix.org",
"access_token": "abc123", "access_token": "abc123",
"home_server": "matrix.org",
"device_id": "GHTYAJCE" "device_id": "GHTYAJCE"
} }
schema: schema:
@ -112,7 +111,12 @@ paths:
This access token can then be used to authorize other requests. This access token can then be used to authorize other requests.
home_server: home_server:
type: string 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`` if they require it. Note also that ``homeserver``
is not spelt this way.
device_id: device_id:
type: string type: string
description: |- description: |-

@ -124,7 +124,6 @@ paths:
application/json: { application/json: {
"user_id": "@cheeky_monkey:matrix.org", "user_id": "@cheeky_monkey:matrix.org",
"access_token": "abc123", "access_token": "abc123",
"home_server": "matrix.org",
"device_id": "GHTYAJCE" "device_id": "GHTYAJCE"
} }
schema: schema:
@ -144,7 +143,12 @@ paths:
This access token can then be used to authorize other requests. This access token can then be used to authorize other requests.
home_server: home_server:
type: string 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`` if they require it. Note also that ``homeserver``
is not spelt this way.
device_id: device_id:
type: string type: string
description: |- description: |-

Loading…
Cancel
Save