From 021c056efc200f968bb1c4c4eb99273c25e8247b Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Mon, 4 Nov 2019 15:55:20 -0700 Subject: [PATCH] Add filter query param to /context This was missed as part of lazy-loading. Fixes https://github.com/matrix-org/matrix-doc/issues/2338 --- api/client-server/event_context.yaml | 11 +++++++++++ .../client_server/newsfragments/2344.clarification | 1 + 2 files changed, 12 insertions(+) create mode 100644 changelogs/client_server/newsfragments/2344.clarification diff --git a/api/client-server/event_context.yaml b/api/client-server/event_context.yaml index 3bea351cf..e0c74cbf6 100644 --- a/api/client-server/event_context.yaml +++ b/api/client-server/event_context.yaml @@ -59,6 +59,17 @@ paths: description: |- The maximum number of events to return. Default: 10. x-example: 3 + - in: query + name: filter + type: string + description: |- + The ID of a filter created using the filter API or a filter JSON + object encoded as a string. The server will detect whether it is + an ID or a JSON object by whether the first character is a ``"{"`` + open brace. + + See `Filtering <#filtering>`_ for more information. + x-example: "66696p746572" responses: 200: description: The events and state surrounding the requested event. diff --git a/changelogs/client_server/newsfragments/2344.clarification b/changelogs/client_server/newsfragments/2344.clarification new file mode 100644 index 000000000..8c92d31ee --- /dev/null +++ b/changelogs/client_server/newsfragments/2344.clarification @@ -0,0 +1 @@ +Add missing information on how filters are meant to work with ``/context``.