Skip to content

Commit 2cbf606

Browse files
authored
Use "server name" instead of "DNS name" to avoid confusion (#1946)
Fixes: #1911 Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
1 parent 75e77b9 commit 2cbf606

File tree

6 files changed

+9
-6
lines changed

6 files changed

+9
-6
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Use "server name" instead of "DNS name" to avoid confusion with the "DNS name" component of "server names" as defined in the appendices.

data/api/server-server/definitions/keys.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ example:
1919
properties:
2020
server_name:
2121
type: string
22-
description: DNS name of the homeserver.
22+
description: The homeserver's [server name](/appendices/#server-name).
2323
example: "example.org"
2424
verify_keys:
2525
type: object

data/api/server-server/joins-v1.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,7 @@ paths:
341341
properties:
342342
origin:
343343
type: string
344-
description: The resident server's DNS name.
344+
description: The resident server's [server name](/appendices/#server-name).
345345
auth_chain:
346346
type: array
347347
description: |-

data/api/server-server/joins-v2.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ paths:
162162
properties:
163163
origin:
164164
type: string
165-
description: The resident server's DNS name.
165+
description: The resident server's [server name](/appendices/#server-name).
166166
members_omitted:
167167
type: boolean
168168
description: "`true` if `m.room.member` events have been omitted from `state`."

data/api/server-server/keys_query.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ paths:
2626
parameters:
2727
- in: path
2828
name: serverName
29-
description: The server's DNS name to query
29+
description: The [server name](/appendices/#server-name) to query
3030
required: true
3131
example: matrix.org
3232
schema:

data/api/server-server/query.yaml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ paths:
4545
description: |-
4646
Performs a query to get the mapped room ID and list of resident homeservers in
4747
the room for a given room alias. Homeservers should only query room aliases
48-
that belong to the target server (identified by the DNS Name in the alias).
48+
that belong to the target server (identified by the [server name](/appendices/#server-name)
49+
in the alias).
4950
5051
Servers may wish to cache the response to this query to avoid requesting the
5152
information too often.
@@ -111,7 +112,8 @@ paths:
111112
description: |-
112113
Performs a query to get profile information, such as a display name or avatar,
113114
for a given user. Homeservers should only query profiles for users that belong
114-
to the target server (identified by the DNS Name in the user ID).
115+
to the target server (identified by the [server name](/appendices/#server-name)
116+
in the user ID).
115117
116118
Servers may wish to cache the response to this query to avoid requesting the
117119
information too often.

0 commit comments

Comments
 (0)