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.

Sign up for GitHub

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

Jump to bottom

Spec implicit filter event limit #1463

Merged
merged 3 commits into from
Mar 14, 2023
Merged

Spec implicit filter event limit #1463

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c35df15
Spec implicit filter event limit
Cadair Mar 14, 2023
34a5ad8
Don't spec a specific number for the limit
Cadair Mar 14, 2023
acba8e9
Add a changelog
Cadair Mar 14, 2023
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
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/1463.clarification
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify that servers should enforce a default `limit` on a filter if one is not specified.
6 changes: 5 additions & 1 deletion data/api/client-server/definitions/event_filter.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@
title: EventFilter
properties:
limit:
description: The maximum number of events to return.
description: |
The maximum number of events to return, must be an integer greater than 0.

Servers should apply a default value, and impose a maximum value to avoid
resource exhaustion.
type: integer
not_senders:
description: A list of sender IDs to exclude. If this list is absent then no senders
Expand Down