Add links to the spec for the definition of 3PID medium (#1417)

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
matrix-org · Jan 30, 2023 · d55af02 · d55af02
1 parent d4586eb
commit d55af02
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/changelogs/client_server/newsfragments/1417.clarification 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
@@ -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
@@ -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.