Clarify that /register must produce valid Matrix User IDs

Fixes https://github.com/matrix-org/matrix-doc/issues/1793
This commit is contained in:
Travis Ralston 2019-06-05 23:23:23 -06:00
parent 9ac89cc915
commit 976f32fcab
2 changed files with 5 additions and 1 deletions

View file

@ -59,6 +59,9 @@ paths:
supplied by the client or generated by the server. The server may supplied by the client or generated by the server. The server may
invalidate any access token previously associated with that device. See invalidate any access token previously associated with that device. See
`Relationship between access tokens and devices`_. `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 operationId: register
parameters: parameters:
- in: query - in: query
@ -142,7 +145,7 @@ paths:
The fully-qualified Matrix user ID (MXID) that has been registered. 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 Any user ID returned by this API must conform to the grammar given in the
`Matrix specification <https://matrix.org/docs/spec/appendices.html#user-identifiers>`_. `Matrix specification <../appendices.html#user-identifiers>`_.
access_token: access_token:
type: string type: string
description: |- description: |-

View file

@ -0,0 +1 @@
Clarify that ``/register`` must produce valid Matrix User IDs.