Clarify formats of string types in account sections (#2046)

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
Kévin Commaille 2025-01-17 18:18:51 +01:00 committed by GitHub
parent ad17652fce
commit d0d71d9997
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 13 additions and 1 deletions

View file

@ -0,0 +1 @@
Clarify formats of string types.

View file

@ -135,6 +135,8 @@ paths:
properties:
user_id:
type: string
format: mx-user-id
pattern: "^@"
description: |-
The fully-qualified Matrix user ID (MXID) that has been registered.
@ -169,6 +171,7 @@ paths:
x-addedInMatrixVersion: "1.3"
home_server:
type: string
format: mx-server-name
deprecated: true
description: |-
The server_name of the homeserver on which the account has

View file

@ -44,6 +44,8 @@ paths:
properties:
user_id:
type: string
format: mx-user-id
pattern: "^@"
description: The user ID that owns the access token.
device_id:
x-addedInMatrixVersion: "1.1"

View file

@ -23,6 +23,7 @@ properties:
example: "monkeys_are_GREAT"
email:
type: string
format: email
description: The email address to validate.
example: "alice@example.org"
send_attempt:
@ -39,6 +40,7 @@ properties:
example: 1
next_link:
type: string
format: uri
description: |-
Optional. When the validation is completed, the identity server will
redirect the user to this URL. This option is ignored when submitting

View file

@ -44,6 +44,7 @@ properties:
example: 1
next_link:
type: string
format: uri
description: |-
Optional. When the validation is completed, the identity server will
redirect the user to this URL. This option is ignored when submitting

View file

@ -9,7 +9,10 @@ properties:
type: object
properties:
base_url:
type: string
anyOf:
- type: string
format: uri
- type: "null"
description: |-
The URL of the identity server the user prefers to use, or `null`
if the user does not want to use an identity server. This value is