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

Spec implicit filter event limit #1463

Merged
merged 3 commits into from
Mar 14, 2023
Merged

Spec implicit filter event limit #1463

Changes from 1 commit
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
2 changes: 1 addition & 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,7 @@
title: EventFilter
properties:
limit:
description: The maximum number of events to return.
description: The maximum number of events to return. If not specified defaults to 10.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not entirely sure we should mandate this, or that we can mandate it, without going through the MSC process: it may well be that non-synapse implementations use a different default.

I think what we need to say instead is that if it's not specified, servers should use an implementation-specific default.

The limit param on GET /threads has sensible wording here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, that makes more sense, I wasn't sure I had understood the original issue.

type: integer
not_senders:
description: A list of sender IDs to exclude. If this list is absent then no senders
Expand Down