diff --git a/api/client-server/event_context.yaml b/api/client-server/event_context.yaml index 3bea351cf4b..5fbfc19899a 100644 --- a/api/client-server/event_context.yaml +++ b/api/client-server/event_context.yaml @@ -59,6 +59,18 @@ paths: description: |- The maximum number of events to return. Default: 10. x-example: 3 + - in: query + name: filter + type: string + description: |- + A JSON ``RoomEventFilter`` to filter the returned events with. The + filter is only applied to ``events_before``, ``events_after``, and + ``state``. It is not applied to the ``event`` itself. The filter may + be applied before or/and after the ``limit`` parameter - whichever the + homeserver prefers. + + 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 00000000000..8c92d31ee54 --- /dev/null +++ b/changelogs/client_server/newsfragments/2344.clarification @@ -0,0 +1 @@ +Add missing information on how filters are meant to work with ``/context``.