From 2cbf6067a6d50ea2160e72d2a570f2cb8eeb0a20 Mon Sep 17 00:00:00 2001
From: Johannes Marbach <n0-0ne+github@mailbox.org>
Date: Wed, 11 Sep 2024 14:56:14 +0200
Subject: [PATCH] Use "server name" instead of "DNS name" to avoid confusion
 (#1946)

Fixes: #1911

Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
---
 changelogs/server_server/newsfragments/1946.clarification | 1 +
 data/api/server-server/definitions/keys.yaml              | 2 +-
 data/api/server-server/joins-v1.yaml                      | 2 +-
 data/api/server-server/joins-v2.yaml                      | 2 +-
 data/api/server-server/keys_query.yaml                    | 2 +-
 data/api/server-server/query.yaml                         | 6 ++++--
 6 files changed, 9 insertions(+), 6 deletions(-)
 create mode 100644 changelogs/server_server/newsfragments/1946.clarification

diff --git a/changelogs/server_server/newsfragments/1946.clarification b/changelogs/server_server/newsfragments/1946.clarification
new file mode 100644
index 00000000..baf02987
--- /dev/null
+++ b/changelogs/server_server/newsfragments/1946.clarification
@@ -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.
\ No newline at end of file
diff --git a/data/api/server-server/definitions/keys.yaml b/data/api/server-server/definitions/keys.yaml
index 748debd8..c3f71083 100644
--- a/data/api/server-server/definitions/keys.yaml
+++ b/data/api/server-server/definitions/keys.yaml
@@ -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
diff --git a/data/api/server-server/joins-v1.yaml b/data/api/server-server/joins-v1.yaml
index a56315d1..a361836c 100644
--- a/data/api/server-server/joins-v1.yaml
+++ b/data/api/server-server/joins-v1.yaml
@@ -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: |-
diff --git a/data/api/server-server/joins-v2.yaml b/data/api/server-server/joins-v2.yaml
index 465207e9..31f8098c 100644
--- a/data/api/server-server/joins-v2.yaml
+++ b/data/api/server-server/joins-v2.yaml
@@ -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`."
diff --git a/data/api/server-server/keys_query.yaml b/data/api/server-server/keys_query.yaml
index ed9e6302..791deb0a 100644
--- a/data/api/server-server/keys_query.yaml
+++ b/data/api/server-server/keys_query.yaml
@@ -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:
diff --git a/data/api/server-server/query.yaml b/data/api/server-server/query.yaml
index efb3a6c9..16ed5e40 100644
--- a/data/api/server-server/query.yaml
+++ b/data/api/server-server/query.yaml
@@ -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.