Clarify string formats in user data endpoints

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
Kévin Commaille 2026-04-22 12:19:15 +02:00
parent c68e687a8c
commit 7c3e5148ac
No known key found for this signature in database
GPG key ID: F26F4BE20A08255B
2 changed files with 16 additions and 6 deletions

View file

@ -46,6 +46,8 @@ paths:
example: "@alice:example.com" example: "@alice:example.com"
schema: schema:
type: string type: string
format: mx-user-id
pattern: "^@"
- in: path - in: path
name: keyName name: keyName
description: The name of the profile field to set. This MUST be either description: The name of the profile field to set. This MUST be either
@ -69,11 +71,11 @@ paths:
description: | description: |
An object which contains exactly one property. The key An object which contains exactly one property. The key
of that property MUST match the `keyName` specified in the URL. of that property MUST match the `keyName` specified in the URL.
For `avatar_url`, the value MUST be an MXC URI string. For `avatar_url`, the value MUST be an MXC URI string.
For `displayname`, the value MUST be a string. For `displayname`, the value MUST be a string.
For `m.tz`, the value MUST be a valid identifier from the [IANA Time Zone Database](https://www.iana.org/time-zones). For `m.tz`, the value MUST be a valid identifier from the [IANA Time Zone Database](https://www.iana.org/time-zones).
Servers MAY choose to validate the value. Clients MUST expect unknown or invalid Servers MAY choose to validate the value. Clients MUST expect unknown or invalid
values. values.
@ -96,7 +98,7 @@ paths:
description: | description: |
The input was invalid in some way. This can include one The input was invalid in some way. This can include one
of the following error codes: of the following error codes:
- `M_BAD_JSON`: The provided value is not valid JSON. - `M_BAD_JSON`: The provided value is not valid JSON.
- `M_MISSING_PARAM`: The required `keyName` property is - `M_MISSING_PARAM`: The required `keyName` property is
missing from the request body. missing from the request body.
@ -158,6 +160,8 @@ paths:
example: "@alice:example.com" example: "@alice:example.com"
schema: schema:
type: string type: string
format: mx-user-id
pattern: "^@"
- in: path - in: path
name: keyName name: keyName
description: The name of the profile field to retrieve. description: The name of the profile field to retrieve.
@ -216,6 +220,8 @@ paths:
example: "@alice:example.com" example: "@alice:example.com"
schema: schema:
type: string type: string
format: mx-user-id
pattern: "^@"
- in: path - in: path
name: keyName name: keyName
description: The name of the profile field to delete. description: The name of the profile field to delete.
@ -286,6 +292,8 @@ paths:
example: "@alice:example.com" example: "@alice:example.com"
schema: schema:
type: string type: string
format: mx-user-id
pattern: "^@"
responses: responses:
"200": "200":
description: The profile information for this user. description: The profile information for this user.

View file

@ -30,7 +30,7 @@ paths:
`public` [join rule](#mroomjoin_rules) `public` [join rule](#mroomjoin_rules)
- users who are joined to rooms known to the homeserver that have a - users who are joined to rooms known to the homeserver that have a
`world_readable` [history visibility](#room-history-visibility) `world_readable` [history visibility](#room-history-visibility)
The search MUST consider local users to the homeserver, and SHOULD The search MUST consider local users to the homeserver, and SHOULD
query remote users as part of the search. query remote users as part of the search.
@ -82,6 +82,8 @@ paths:
type: string type: string
example: "@foo:bar.com" example: "@foo:bar.com"
description: The user's matrix user ID. description: The user's matrix user ID.
format: mx-user-id
pattern: "^@"
display_name: display_name:
type: string type: string
example: Foo example: Foo