diff --git a/api/client-server/definitions/event_filter.yaml b/api/client-server/definitions/event_filter.yaml index 27cce87d..8bedacb2 100644 --- a/api/client-server/definitions/event_filter.yaml +++ b/api/client-server/definitions/event_filter.yaml @@ -5,14 +5,14 @@ properties: not_senders: description: A list of sender IDs to exclude. If this list is absent then no senders are excluded. A matching sender will be excluded even if it is listed in the - 'senders' filter. + ``'senders'`` filter. items: type: string type: array not_types: description: A list of event types to exclude. If this list is absent then no event types are excluded. A matching type will be excluded even if it is listed - in the 'types' filter. A '*' can be used as a wildcard to match any sequence + in the ``'types'`` filter. A '*' can be used as a wildcard to match any sequence of characters. items: type: string @@ -25,7 +25,7 @@ properties: type: array types: description: A list of event types to include. If this list is absent then all - event types are included. A '*' can be used as a wildcard to match any sequence + event types are included. A ``'*'`` can be used as a wildcard to match any sequence of characters. items: type: string diff --git a/api/client-server/definitions/room_event_filter.yaml b/api/client-server/definitions/room_event_filter.yaml index 628e2ca8..0ad1ae33 100644 --- a/api/client-server/definitions/room_event_filter.yaml +++ b/api/client-server/definitions/room_event_filter.yaml @@ -3,7 +3,7 @@ allOf: properties: not_rooms: description: A list of room IDs to exclude. If this list is absent then no rooms - are excluded. A matching room will be excluded even if it is listed in the 'rooms' + are excluded. A matching room will be excluded even if it is listed in the ``'rooms'`` filter. items: type: string diff --git a/api/client-server/definitions/sync_filter.yaml b/api/client-server/definitions/sync_filter.yaml index fc154f3a..09307c99 100644 --- a/api/client-server/definitions/sync_filter.yaml +++ b/api/client-server/definitions/sync_filter.yaml @@ -26,6 +26,21 @@ properties: description: The user account data that isn't associated with rooms to include. room: properties: + not_rooms: + description: A list of room IDs to exclude. If this list is absent then no rooms + are excluded. A matching room will be excluded even if it is listed in the ``'rooms'`` + filter. This filter is applied before the filters in ``ephemeral``, + ``state``, ``timeline`` or ``account_data`` + items: + type: string + type: array + rooms: + description: A list of room IDs to include. If this list is absent then all rooms + are included. This filter is applied before the filters in ``ephemeral``, + ``state``, ``timeline`` or ``account_data`` + items: + type: string + type: array ephemeral: allOf: - $ref: room_event_filter.yaml