Use "server name" instead of "DNS name" to avoid confusion (#1946)
Fixes: #1911 Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
This commit is contained in:
parent
75e77b96ff
commit
2cbf6067a6
6 changed files with 9 additions and 6 deletions
|
@ -0,0 +1 @@
|
||||||
|
Use "server name" instead of "DNS name" to avoid confusion with the "DNS name" component of "server names" as defined in the appendices.
|
|
@ -19,7 +19,7 @@ example:
|
||||||
properties:
|
properties:
|
||||||
server_name:
|
server_name:
|
||||||
type: string
|
type: string
|
||||||
description: DNS name of the homeserver.
|
description: The homeserver's [server name](/appendices/#server-name).
|
||||||
example: "example.org"
|
example: "example.org"
|
||||||
verify_keys:
|
verify_keys:
|
||||||
type: object
|
type: object
|
||||||
|
|
|
@ -341,7 +341,7 @@ paths:
|
||||||
properties:
|
properties:
|
||||||
origin:
|
origin:
|
||||||
type: string
|
type: string
|
||||||
description: The resident server's DNS name.
|
description: The resident server's [server name](/appendices/#server-name).
|
||||||
auth_chain:
|
auth_chain:
|
||||||
type: array
|
type: array
|
||||||
description: |-
|
description: |-
|
||||||
|
|
|
@ -162,7 +162,7 @@ paths:
|
||||||
properties:
|
properties:
|
||||||
origin:
|
origin:
|
||||||
type: string
|
type: string
|
||||||
description: The resident server's DNS name.
|
description: The resident server's [server name](/appendices/#server-name).
|
||||||
members_omitted:
|
members_omitted:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: "`true` if `m.room.member` events have been omitted from `state`."
|
description: "`true` if `m.room.member` events have been omitted from `state`."
|
||||||
|
|
|
@ -26,7 +26,7 @@ paths:
|
||||||
parameters:
|
parameters:
|
||||||
- in: path
|
- in: path
|
||||||
name: serverName
|
name: serverName
|
||||||
description: The server's DNS name to query
|
description: The [server name](/appendices/#server-name) to query
|
||||||
required: true
|
required: true
|
||||||
example: matrix.org
|
example: matrix.org
|
||||||
schema:
|
schema:
|
||||||
|
|
|
@ -45,7 +45,8 @@ paths:
|
||||||
description: |-
|
description: |-
|
||||||
Performs a query to get the mapped room ID and list of resident homeservers in
|
Performs a query to get the mapped room ID and list of resident homeservers in
|
||||||
the room for a given room alias. Homeservers should only query room aliases
|
the room for a given room alias. Homeservers should only query room aliases
|
||||||
that belong to the target server (identified by the DNS Name in the alias).
|
that belong to the target server (identified by the [server name](/appendices/#server-name)
|
||||||
|
in the alias).
|
||||||
|
|
||||||
Servers may wish to cache the response to this query to avoid requesting the
|
Servers may wish to cache the response to this query to avoid requesting the
|
||||||
information too often.
|
information too often.
|
||||||
|
@ -111,7 +112,8 @@ paths:
|
||||||
description: |-
|
description: |-
|
||||||
Performs a query to get profile information, such as a display name or avatar,
|
Performs a query to get profile information, such as a display name or avatar,
|
||||||
for a given user. Homeservers should only query profiles for users that belong
|
for a given user. Homeservers should only query profiles for users that belong
|
||||||
to the target server (identified by the DNS Name in the user ID).
|
to the target server (identified by the [server name](/appendices/#server-name)
|
||||||
|
in the user ID).
|
||||||
|
|
||||||
Servers may wish to cache the response to this query to avoid requesting the
|
Servers may wish to cache the response to this query to avoid requesting the
|
||||||
information too often.
|
information too often.
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue