Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add filter query param to /context #2344

Merged
merged 4 commits into from Nov 6, 2019
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 10 additions & 0 deletions api/client-server/event_context.yaml
Expand Up @@ -59,6 +59,16 @@ 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
turt2live marked this conversation as resolved.
Show resolved Hide resolved
filter can be applied before or/and after the ``limit`` parameter -
turt2live marked this conversation as resolved.
Show resolved Hide resolved
whichever the homeserver prefers.

See `Filtering <#filtering>`_ for more information.
x-example: "66696p746572"
responses:
200:
description: The events and state surrounding the requested event.
Expand Down
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/2344.clarification
@@ -0,0 +1 @@
Add missing information on how filters are meant to work with ``/context``.