Clarify some string formats of room summary endpoint

Using the custom string formats supported by the spec.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
Kévin Commaille 2025-06-07 10:01:05 +02:00
parent 7bcc3ecb81
commit 769044b2c5
No known key found for this signature in database
GPG key ID: F26F4BE20A08255B
3 changed files with 14 additions and 1 deletions

View file

@ -17,6 +17,8 @@ title: "PublishedRoomsChunk"
properties: properties:
canonical_alias: canonical_alias:
type: string type: string
format: mx-room-alias
pattern: "^#"
description: The canonical alias of the room, if any. description: The canonical alias of the room, if any.
example: "#general:example.org" example: "#general:example.org"
name: name:
@ -29,6 +31,8 @@ properties:
example: 42 example: 42
room_id: room_id:
type: string type: string
format: mx-room-id
pattern: "^!"
description: The ID of the room. description: The ID of the room.
example: "!abcdefg:example.org" example: "!abcdefg:example.org"
topic: topic:

View file

@ -27,6 +27,8 @@ allOf:
type: array type: array
items: items:
type: string type: string
format: mx-room-id
pattern: "^!"
description: |- description: |-
If the room is a [restricted room](/server-server-api/#restricted-rooms), these are the room IDs which If the room is a [restricted room](/server-server-api/#restricted-rooms), these are the room IDs which
are specified by the join rules. Empty or omitted otherwise. are specified by the join rules. Empty or omitted otherwise.

View file

@ -46,7 +46,13 @@ paths:
required: true required: true
example: "#monkeys:matrix.org" example: "#monkeys:matrix.org"
schema: schema:
type: string oneOf:
- type: string
format: mx-room-id
pattern: "^!"
- type: string
format: mx-room-alias
pattern: "^#"
- in: query - in: query
name: via name: via
description: |- description: |-
@ -60,6 +66,7 @@ paths:
type: array type: array
items: items:
type: string type: string
format: mx-server-name
responses: responses:
"200": "200":
description: A summary of the room. description: A summary of the room.