diff --git a/changelogs/client_server/newsfragments/1417.clarification b/changelogs/client_server/newsfragments/1417.clarification new file mode 100644 index 000000000..b1b0b8c95 --- /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 97c3dc918..07d9c0afe 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 cf4a0d34f..27bcad370 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.