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

Clarify string formats of rooms endpoints

Browse source 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
Kévin Commaille 2026-04-22 12:02:59 +02:00
parent c68e687a8c
commit cbbbeeedfc
No known key found for this signature in database
GPG key ID: F26F4BE20A08255B
11 changed files with 75 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
data/api/client-server/banning.yaml
View file

@ -37,6 +37,8 @@ paths:
example: "!e42d8c:matrix.org"
schema:
type: string
format: mx-room-id
pattern: "^!"
requestBody:
content:
application/json:
@ -50,6 +52,8 @@ paths:
user_id:
type: string
description: The fully qualified user ID of the user being banned.
format: mx-user-id
pattern: "^@"
reason:
x-addedInMatrixVersion: "1.1"
type: string
@ -108,6 +112,8 @@ paths:
example: "!e42d8c:matrix.org"
schema:
type: string
format: mx-room-id
pattern: "^!"
requestBody:
content:
application/json:
@ -121,6 +127,8 @@ paths:
user_id:
type: string
description: The fully qualified user ID of the user being unbanned.
format: mx-user-id
pattern: "^@"
reason:
x-addedInMatrixVersion: "1.1"
type: string

4
data/api/client-server/create_room.yaml
View file

@ -140,6 +140,8 @@ paths:
server to invite everyone in the list to the newly created room.
items:
type: string
format: mx-user-id
pattern: "^@"
invite_3pid:
type: array
description: |-
@ -241,6 +243,8 @@ paths:
room_id:
type: string
description: The created room's ID.
format: mx-room-id
pattern: "^!"
required:
- room_id
examples:

4
data/api/client-server/definitions/third_party_signed.yaml
View file

@ -20,10 +20,14 @@ properties:
sender:
type: string
description: The Matrix ID of the user who issued the invite.
format: mx-user-id
pattern: "^@"
example: "@alice:example.org"
mxid:
type: string
description: The Matrix ID of the invitee.
format: mx-user-id
pattern: "^@"
example: "@bob:example.org"
token:
type: string

15
data/api/client-server/directory.yaml
View file

@ -33,6 +33,8 @@ paths:
example: "#monkeys:matrix.org"
schema:
type: string
format: mx-room-alias
pattern: "^#"
requestBody:
content:
application/json:
@ -42,6 +44,8 @@ paths:
room_id:
type: string
description: The room ID to set.
format: mx-room-id
pattern: "^!"
required:
- room_id
example: {
@ -104,6 +108,8 @@ paths:
example: "#monkeys:matrix.org"
schema:
type: string
format: mx-room-alias
pattern: "^#"
responses:
"200":
description: The room ID and other information for this alias.
@ -115,12 +121,15 @@ paths:
room_id:
type: string
description: The room ID for this room alias.
format: mx-room-id
pattern: "^!"
servers:
type: array
description: A list of servers that are aware of this room alias.
items:
type: string
description: A server which is aware of this room alias.
format: mx-server-name
examples:
response:
value: {
@ -185,6 +194,8 @@ paths:
example: "#monkeys:matrix.org"
schema:
type: string
format: mx-room-alias
pattern: "^#"
responses:
"200":
description: The mapping was deleted.
@ -241,6 +252,8 @@ paths:
example: "!abc123:example.org"
schema:
type: string
format: mx-room-id
pattern: "^!"
responses:
"200":
description: The list of local aliases for the room.
@ -254,6 +267,8 @@ paths:
description: The server's local aliases on the room. Can be empty.
items:
type: string
format: mx-room-alias
pattern: "^#"
required:
- aliases
examples:

4
data/api/client-server/inviting.yaml
View file

@ -48,6 +48,8 @@ paths:
example: "!d41d8cd:matrix.org"
schema:
type: string
format: mx-room-id
pattern: "^!"
requestBody:
content:
application/json:
@ -61,6 +63,8 @@ paths:
user_id:
type: string
description: The fully qualified user ID of the invitee.
format: mx-user-id
pattern: "^@"
reason:
x-addedInMatrixVersion: "1.1"
type: string

15
data/api/client-server/joining.yaml
View file

@ -43,6 +43,8 @@ paths:
example: "!d41d8cd:matrix.org"
schema:
type: string
format: mx-room-id
pattern: "^!"
requestBody:
content:
application/json:
@ -78,6 +80,8 @@ paths:
room_id:
type: string
description: The joined room ID.
format: mx-room-id
pattern: "^!"
required:
- room_id
examples:
@ -136,7 +140,13 @@ paths:
required: true
example: "#monkeys:matrix.org"
schema:
type: string
oneOf:
- type: string
format: mx-room-id
pattern: "^!"
- type: string
format: mx-room-alias
pattern: "^#"
- in: query
name: via
x-addedInMatrixVersion: "1.12"
@ -150,6 +160,7 @@ paths:
type: array
items:
type: string
format: mx-server-name
requestBody:
content:
application/json:
@ -185,6 +196,8 @@ paths:
room_id:
type: string
description: The joined room ID.
format: mx-room-id
pattern: "^!"
required:
- room_id
examples:

4
data/api/client-server/kicking.yaml
View file

@ -39,6 +39,8 @@ paths:
example: "!e42d8c:matrix.org"
schema:
type: string
format: mx-room-id
pattern: "^!"
requestBody:
content:
application/json:
@ -52,6 +54,8 @@ paths:
user_id:
type: string
description: The fully qualified user ID of the user being kicked.
format: mx-user-id
pattern: "^@"
reason:
type: string
description: |-

11
data/api/client-server/knocking.yaml
View file

@ -47,7 +47,13 @@ paths:
required: true
example: "#monkeys:matrix.org"
schema:
type: string
oneOf:
- type: string
format: mx-room-id
pattern: "^!"
- type: string
format: mx-room-alias
pattern: "^#"
- in: query
name: via
x-addedInMatrixVersion: "1.12"
@ -61,6 +67,7 @@ paths:
type: array
items:
type: string
format: mx-server-name
requestBody:
content:
application/json:
@ -88,6 +95,8 @@ paths:
room_id:
type: string
description: The knocked room ID.
format: mx-room-id
pattern: "^!"
required:
- room_id
examples:

4
data/api/client-server/leaving.yaml
View file

@ -54,6 +54,8 @@ paths:
example: "!nkl290a:matrix.org"
schema:
type: string
format: mx-room-id
pattern: "^!"
requestBody:
content:
application/json:
@ -113,6 +115,8 @@ paths:
example: "!au1ba7o:matrix.org"
schema:
type: string
format: mx-room-id
pattern: "^!"
responses:
"200":
description: The room has been forgotten.

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

@ -39,6 +39,8 @@ paths:
description: The ID of each room in which the user has `joined` membership.
items:
type: string
format: mx-room-id
pattern: "^!"
examples:
response:
value: {

6
data/api/client-server/list_public_rooms.yaml
View file

@ -31,6 +31,8 @@ paths:
example: "!curbf:matrix.org"
schema:
type: string
format: mx-room-id
pattern: "^!"
responses:
"200":
description: The visibility of the room in the directory.
@ -84,6 +86,8 @@ paths:
example: "!curbf:matrix.org"
schema:
type: string
format: mx-room-id
pattern: "^!"
requestBody:
content:
application/json:
@ -158,6 +162,7 @@ paths:
to the local server. Case sensitive.
schema:
type: string
format: mx-server-name
responses:
"200":
description: A list of the published rooms on the server.
@ -186,6 +191,7 @@ paths:
to the local server. Case sensitive.
schema:
type: string
format: mx-server-name
requestBody:
content:
application/json: