Clarify string format of filtering endpoints.

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
Kévin Commaille 2026-03-30 16:41:08 +02:00
parent 2192bfa996
commit 7dad9ebc43
No known key found for this signature in database
GPG key ID: F26F4BE20A08255B
4 changed files with 16 additions and 0 deletions

View file

@ -26,6 +26,8 @@ properties:
`senders` filter. `senders` filter.
items: items:
type: string type: string
format: mx-user-id
pattern: "^@"
type: array type: array
not_types: not_types:
description: A list of event types to exclude. If this list is absent then no description: A list of event types to exclude. If this list is absent then no
@ -40,6 +42,8 @@ properties:
senders are included. senders are included.
items: items:
type: string type: string
format: mx-user-id
pattern: "^@"
type: array type: array
types: types:
description: A list of event types to include. If this list is absent then all description: A list of event types to include. If this list is absent then all

View file

@ -43,12 +43,16 @@ allOf:
filter. filter.
items: items:
type: string type: string
format: mx-room-id
pattern: "^!"
type: array type: array
rooms: rooms:
description: A list of room IDs to include. If this list is absent then all rooms description: A list of room IDs to include. If this list is absent then all rooms
are included. are included.
items: items:
type: string type: string
format: mx-room-id
pattern: "^!"
type: array type: array
contains_url: contains_url:
type: boolean type: boolean

View file

@ -50,6 +50,8 @@ properties:
`state`, `timeline` or `account_data` `state`, `timeline` or `account_data`
items: items:
type: string type: string
format: mx-room-id
pattern: "^!"
type: array type: array
rooms: rooms:
description: A list of room IDs to include. If this list is absent then all rooms description: A list of room IDs to include. If this list is absent then all rooms
@ -57,6 +59,8 @@ properties:
`state`, `timeline` or `account_data` `state`, `timeline` or `account_data`
items: items:
type: string type: string
format: mx-room-id
pattern: "^!"
type: array type: array
ephemeral: ephemeral:
allOf: allOf:

View file

@ -36,6 +36,8 @@ paths:
example: "@alice:example.com" example: "@alice:example.com"
schema: schema:
type: string type: string
format: mx-user-id
pattern: "^@"
requestBody: requestBody:
content: content:
application/json: application/json:
@ -130,6 +132,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: filterId name: filterId
description: The filter ID to download. description: The filter ID to download.