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``.