From 9f01850f7aa6fa6ec96f383716b1b0eff326e309 Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Wed, 6 Nov 2019 10:43:11 -0700 Subject: [PATCH] Add some words about where the filter is applied --- api/client-server/event_context.yaml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/api/client-server/event_context.yaml b/api/client-server/event_context.yaml index f76cbff13..5fbfc1989 100644 --- a/api/client-server/event_context.yaml +++ b/api/client-server/event_context.yaml @@ -64,8 +64,10 @@ paths: type: string description: |- A JSON ``RoomEventFilter`` to filter the returned events with. The - filter may be applied before or/and after the ``limit`` parameter - - whichever the homeserver prefers. + 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"