From 085131b61717bb2fa3ad6fa3e9d671a61005c37d Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Thu, 29 Sep 2016 11:38:32 +0100 Subject: [PATCH 1/6] Add contains_url filter option --- api/client-server/definitions/room_event_filter.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/api/client-server/definitions/room_event_filter.yaml b/api/client-server/definitions/room_event_filter.yaml index a3bb6852..c2923eae 100644 --- a/api/client-server/definitions/room_event_filter.yaml +++ b/api/client-server/definitions/room_event_filter.yaml @@ -28,4 +28,8 @@ properties: items: type: string type: array + contains_url: + type: boolean + description: If specified will filter events based on if they have a url key in their + content. type: object From 37f6769a3c454d14e89817154cb85c9870e8c42e Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Thu, 29 Sep 2016 13:40:20 +0100 Subject: [PATCH 2/6] Spec filter param on /messagse --- api/client-server/message_pagination.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/api/client-server/message_pagination.yaml b/api/client-server/message_pagination.yaml index 853e0ec3..9370325b 100644 --- a/api/client-server/message_pagination.yaml +++ b/api/client-server/message_pagination.yaml @@ -75,6 +75,11 @@ paths: description: |- The maximum number of events to return. Default: 10. x-example: "3" + - in: query + type: string + name: filter + description: |- + A url encoded JSON RoomEventFilter to filter returned events with. responses: 200: description: A list of messages with a new token to request more. From 51248dd0c8ccef868c00883bcc4e9f18026ab6a4 Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Thu, 29 Sep 2016 17:22:43 +0100 Subject: [PATCH 3/6] Update changelog --- changelogs/client_server.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/changelogs/client_server.rst b/changelogs/client_server.rst index d7384e31..19c996da 100644 --- a/changelogs/client_server.rst +++ b/changelogs/client_server.rst @@ -35,6 +35,10 @@ - Add top-level ``account_data`` key to the responses to ``GET /sync`` and ``GET /initialSync`` (`#380 `_). + - Add ``contains_url`` to ``RoomEventFilter``. + (`#390 `_). + - Add ``filter`` query param to ``/messages`` + (`#390 `_). r0.2.0 ====== From 7919e8e1596529cbc9dcace43250c08f2f397f0c Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Fri, 30 Sep 2016 15:02:27 +0100 Subject: [PATCH 4/6] Update wording. --- api/client-server/definitions/room_event_filter.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/api/client-server/definitions/room_event_filter.yaml b/api/client-server/definitions/room_event_filter.yaml index c2923eae..7d9184b5 100644 --- a/api/client-server/definitions/room_event_filter.yaml +++ b/api/client-server/definitions/room_event_filter.yaml @@ -30,6 +30,6 @@ properties: type: array contains_url: type: boolean - description: If specified will filter events based on if they have a url key in their - content. + description: If ``true``, includes only events with a url key in their content. If + ``false``, excludes those events. type: object From a10fe9fa434f8b9e8c485b55143c107680f99992 Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Fri, 30 Sep 2016 15:04:42 +0100 Subject: [PATCH 5/6] Update changelog --- changelogs/client_server.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/changelogs/client_server.rst b/changelogs/client_server.rst index 19c996da..ec74bda9 100644 --- a/changelogs/client_server.rst +++ b/changelogs/client_server.rst @@ -35,9 +35,9 @@ - Add top-level ``account_data`` key to the responses to ``GET /sync`` and ``GET /initialSync`` (`#380 `_). - - Add ``contains_url`` to ``RoomEventFilter``. + - Add ``contains_url`` option to ``RoomEventFilter``. (`#390 `_). - - Add ``filter`` query param to ``/messages`` + - Add ``filter`` optional query param to ``/messages`` (`#390 `_). r0.2.0 From 069aa86a108c85b09aa46bc29406283ce1c76339 Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Fri, 30 Sep 2016 15:06:11 +0100 Subject: [PATCH 6/6] Update wording and add example to filter param --- api/client-server/message_pagination.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/api/client-server/message_pagination.yaml b/api/client-server/message_pagination.yaml index 9370325b..005b8fb3 100644 --- a/api/client-server/message_pagination.yaml +++ b/api/client-server/message_pagination.yaml @@ -79,7 +79,9 @@ paths: type: string name: filter description: |- - A url encoded JSON RoomEventFilter to filter returned events with. + A JSON RoomEventFilter to filter returned events with. + x-example: |- + {"contains_url":true} responses: 200: description: A list of messages with a new token to request more.