Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify formats of string types in account sections #2046

Merged
merged 5 commits into from
Jan 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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"
Comment on lines +12 to +15
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also changed this definition to make it clearer that a null value has a different meaning than if the field is absent.

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
Loading