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

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
pull/2059/head
Kévin Commaille 11 months ago committed by GitHub
parent ad17652fce
commit d0d71d9997
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

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

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

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

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

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

Loading…
Cancel
Save