From d55af02738a2b8a061f1881d18a60c00188420e7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?K=C3=A9vin=20Commaille?=
 <76261501+zecakeh@users.noreply.github.com>
Date: Mon, 30 Jan 2023 12:36:51 +0100
Subject: [PATCH] Add links to the spec for the definition of 3PID `medium`
 (#1417)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
---
 changelogs/client_server/newsfragments/1417.clarification | 1 +
 data/api/client-server/create_room.yaml                   | 5 +++--
 data/api/client-server/third_party_membership.yaml        | 5 +++--
 3 files changed, 7 insertions(+), 4 deletions(-)
 create mode 100644 changelogs/client_server/newsfragments/1417.clarification

diff --git a/changelogs/client_server/newsfragments/1417.clarification b/changelogs/client_server/newsfragments/1417.clarification
new file mode 100644
index 00000000..b1b0b8c9
--- /dev/null
+++ b/changelogs/client_server/newsfragments/1417.clarification
@@ -0,0 +1 @@
+Add links to the spec for the definition of 3PID `medium`.
diff --git a/data/api/client-server/create_room.yaml b/data/api/client-server/create_room.yaml
index 97c3dc91..07d9c0af 100644
--- a/data/api/client-server/create_room.yaml
+++ b/data/api/client-server/create_room.yaml
@@ -155,8 +155,9 @@ paths:
                         and this specification version.
                     medium:
                       type: string
-                      # TODO: Link to Identity Service spec when it eixsts
-                      description: The kind of address being passed in the address field, for example `email`.
+                      description: |-
+                        The kind of address being passed in the address field, for example `email`
+                        (see [the list of recognised values](/appendices/#3pid-types)).
                     address:
                       type: string
                       description: The invitee's third party identifier.
diff --git a/data/api/client-server/third_party_membership.yaml b/data/api/client-server/third_party_membership.yaml
index cf4a0d34..27bcad37 100644
--- a/data/api/client-server/third_party_membership.yaml
+++ b/data/api/client-server/third_party_membership.yaml
@@ -105,8 +105,9 @@ paths:
                   and this specification version.
               medium:
                 type: string
-                # TODO: Link to Identity Service spec when it eixsts
-                description: The kind of address being passed in the address field, for example `email`.
+                description: |-
+                  The kind of address being passed in the address field, for example
+                  `email` (see [the list of recognised values](/appendices/#3pid-types)).
               address:
                 type: string
                 description: The invitee's third party identifier.