From 976f32fcab51fde2de0301a7844c9470a9fd7ab4 Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Wed, 5 Jun 2019 23:23:23 -0600 Subject: [PATCH] Clarify that /register must produce valid Matrix User IDs Fixes https://github.com/matrix-org/matrix-doc/issues/1793 --- api/client-server/registration.yaml | 5 ++++- changelogs/client_server/newsfragments/2091.clarification | 1 + 2 files changed, 5 insertions(+), 1 deletion(-) create mode 100644 changelogs/client_server/newsfragments/2091.clarification diff --git a/api/client-server/registration.yaml b/api/client-server/registration.yaml index 3195ab41..6fa99550 100644 --- a/api/client-server/registration.yaml +++ b/api/client-server/registration.yaml @@ -59,6 +59,9 @@ paths: supplied by the client or generated by the server. The server may invalidate any access token previously associated with that device. See `Relationship between access tokens and devices`_. + + Any user ID returned by this API must conform to the grammar given in the + `Matrix specification <../appendices.html#user-identifiers>`_. operationId: register parameters: - in: query @@ -142,7 +145,7 @@ paths: The fully-qualified Matrix user ID (MXID) that has been registered. Any user ID returned by this API must conform to the grammar given in the - `Matrix specification `_. + `Matrix specification <../appendices.html#user-identifiers>`_. access_token: type: string description: |- diff --git a/changelogs/client_server/newsfragments/2091.clarification b/changelogs/client_server/newsfragments/2091.clarification new file mode 100644 index 00000000..2c4a276e --- /dev/null +++ b/changelogs/client_server/newsfragments/2091.clarification @@ -0,0 +1 @@ +Clarify that ``/register`` must produce valid Matrix User IDs.