Merge pull request #2091 from matrix-org/travis/1.0/mxid-register

Clarify that /register must produce valid Matrix User IDs
This commit is contained in:
Travis Ralston 2019-06-10 11:08:41 -06:00 committed by GitHub
commit 36659ca266
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 1 deletions

View file

@ -65,6 +65,9 @@ paths:
with the exception of ``initial_device_display_name`` MUST BE ignored with the exception of ``initial_device_display_name`` MUST BE ignored
by the server. The server MUST pick a ``device_id`` for the account by the server. The server MUST pick a ``device_id`` for the account
regardless of input. regardless of input.
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
@ -152,7 +155,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.