From a32ed96a0ff973ddddc316dd3ab0efb446e73a8f Mon Sep 17 00:00:00 2001 From: Mark Haines Date: Mon, 21 Dec 2015 20:31:02 +0000 Subject: [PATCH 1/4] Document filtering for account data --- api/client-server/definitions/sync_filter.yaml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/api/client-server/definitions/sync_filter.yaml b/api/client-server/definitions/sync_filter.yaml index 4aa78e77..fc154f3a 100644 --- a/api/client-server/definitions/sync_filter.yaml +++ b/api/client-server/definitions/sync_filter.yaml @@ -20,6 +20,10 @@ properties: allOf: - $ref: event_filter.yaml description: The presence updates to include. + account_data: + allOf: + - $ref: event_filter.yaml + description: The user account data that isn't associated with rooms to include. room: properties: ephemeral: @@ -38,5 +42,9 @@ properties: allOf: - $ref: room_event_filter.yaml description: The message and state update events to include for rooms. + account_data: + allOf: + - $ref: room_event_filter.yaml + description: The per user account data to include for rooms. type: object type: object From 288c7ed35381de91c598ea82fed3f7a892b315d1 Mon Sep 17 00:00:00 2001 From: Mark Haines Date: Mon, 21 Dec 2015 20:44:06 +0000 Subject: [PATCH 2/4] Add top level filters for filtering by room id. --- api/client-server/definitions/sync_filter.yaml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/api/client-server/definitions/sync_filter.yaml b/api/client-server/definitions/sync_filter.yaml index fc154f3a..1691ca31 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 From 9b4a37f57b192fa962ae6722b9a9aa6d790fd4fc Mon Sep 17 00:00:00 2001 From: Mark Haines Date: Tue, 22 Dec 2015 11:44:05 +0000 Subject: [PATCH 3/4] backticks --- api/client-server/definitions/event_filter.yaml | 6 +++--- api/client-server/definitions/sync_filter.yaml | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) 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/sync_filter.yaml b/api/client-server/definitions/sync_filter.yaml index 1691ca31..09307c99 100644 --- a/api/client-server/definitions/sync_filter.yaml +++ b/api/client-server/definitions/sync_filter.yaml @@ -28,7 +28,7 @@ properties: 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. This filter is applied before the filters in ``ephemeral``, ``state``, ``timeline`` or ``account_data`` items: From 4c4393997741911d88c4d53e04bb49b5cf624f79 Mon Sep 17 00:00:00 2001 From: Mark Haines Date: Tue, 22 Dec 2015 11:48:11 +0000 Subject: [PATCH 4/4] more backticks --- api/client-server/definitions/room_event_filter.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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