Skip to content

Commit

Permalink
Clarify formats of string types in account sections (#2046)
Browse files Browse the repository at this point in the history
Signed-off-by: Kévin Commaille <[email protected]>
  • Loading branch information
zecakeh authored Jan 17, 2025
1 parent ad17652 commit d0d71d9
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 1 deletion.
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/2046.clarification
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify formats of string types.
3 changes: 3 additions & 0 deletions data/api/client-server/registration.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions data/api/client-server/whoami.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 2 additions & 0 deletions data/api/identity/definitions/request_email_validation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ properties:
example: "monkeys_are_GREAT"
email:
type: string
format: email
description: The email address to validate.
example: "[email protected]"
send_attempt:
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 4 additions & 1 deletion data/event-schemas/schema/m.identity_server.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit d0d71d9

Please sign in to comment.