Clarify formats of string types in account management section

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
Kévin Commaille 2025-01-06 04:06:58 +01:00
parent 6f1e64cb12
commit 1ca88fb6a0
No known key found for this signature in database
GPG key ID: 0C971D9DBC9D678D
5 changed files with 9 additions and 0 deletions

View file

@ -18,6 +18,7 @@ allOf:
properties:
id_server:
type: string
format: mx-server-name
description: |-
The hostname of the identity server to communicate with. May optionally
include a port. This parameter is ignored when the homeserver handles

View file

@ -18,6 +18,7 @@ allOf:
properties:
id_server:
type: string
format: mx-server-name
description: |-
The hostname of the identity server to communicate with. May optionally
include a port. This parameter is ignored when the homeserver handles

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
@ -611,6 +614,7 @@ paths:
- $ref: definitions/auth_data.yaml
id_server:
type: string
format: mx-server-name
description: |-
The identity server to unbind all of the user's 3PIDs from.
If not provided, the homeserver MUST use the `id_server`

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