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 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions api/client-server/event_context.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
turt2live marked this conversation as resolved.
Show resolved Hide resolved
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.
Expand Down
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/2344.clarification
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add missing information on how filters are meant to work with ``/context``.