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:
Johannes Marbach 2024-09-11 14:56:14 +02:00 committed by GitHub
parent 75e77b96ff
commit 2cbf6067a6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 9 additions and 6 deletions

View file

@ -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.

View file

@ -19,7 +19,7 @@ example:
properties:
server_name:
type: string
description: DNS name of the homeserver.
description: The homeserver's [server name](/appendices/#server-name).
example: "example.org"
verify_keys:
type: object

View file

@ -341,7 +341,7 @@ paths:
properties:
origin:
type: string
description: The resident server's DNS name.
description: The resident server's [server name](/appendices/#server-name).
auth_chain:
type: array
description: |-

View file

@ -162,7 +162,7 @@ paths:
properties:
origin:
type: string
description: The resident server's DNS name.
description: The resident server's [server name](/appendices/#server-name).
members_omitted:
type: boolean
description: "`true` if `m.room.member` events have been omitted from `state`."

View file

@ -26,7 +26,7 @@ paths:
parameters:
- in: path
name: serverName
description: The server's DNS name to query
description: The [server name](/appendices/#server-name) to query
required: true
example: matrix.org
schema:

View file

@ -45,7 +45,8 @@ paths:
description: |-
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
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
information too often.
@ -111,7 +112,8 @@ paths:
description: |-
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
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
information too often.