Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-04-30 06:04:10 +02:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Clarify string formats in user data endpoints

Browse source 
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
Show stats Download patch file Download diff file Expand all files Collapse all files

8
data/api/client-server/profile.yaml
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
@ -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.

2
data/api/client-server/users.yaml
View file

@ -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