Skip to content

Commit

Permalink
Use "server name" instead of "DNS name" to avoid confusion (#1946)
Browse files Browse the repository at this point in the history
Fixes: #1911

Signed-off-by: Johannes Marbach <[email protected]>
  • Loading branch information
Johennes committed Sep 11, 2024
1 parent 75e77b9 commit 2cbf606
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 6 deletions.
1 change: 1 addition & 0 deletions changelogs/server_server/newsfragments/1946.clarification
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion data/api/server-server/definitions/keys.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion data/api/server-server/joins-v1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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: |-
Expand Down
2 changes: 1 addition & 1 deletion data/api/server-server/joins-v2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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`."
Expand Down
2 changes: 1 addition & 1 deletion data/api/server-server/keys_query.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
6 changes: 4 additions & 2 deletions data/api/server-server/query.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 2cbf606

Please sign in to comment.