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

Clarify that lazy_load_members in timeline isn't respected in /sync #2010

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clarify that lazy_load_members in timeline isn't respected in /sync #2010

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions data/api/client-server/definitions/room_event_filter.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,17 @@ allOf:
description: |-
If `true`, enables lazy-loading of membership events. See
[Lazy-loading room members](/client-server-api/#lazy-loading-room-members)
for more information. Defaults to `false`.
for more information. Defaults to `false`. Only applies to the `/messages`
Copy link
Contributor

Choose a reason for hiding this comment

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

It should also apply to the /context endpoint, as listed in the "lazy-loading room members" section. I believe it would be better to only list exceptions here.

endpoint, for `/sync` this should be specified in `StateFilter` instead.
include_redundant_members:
type: boolean
description: |-
If `true`, sends all membership events for all events, even if they have already
been sent to the client. Does not
apply unless `lazy_load_members` is `true`. See
[Lazy-loading room members](/client-server-api/#lazy-loading-room-members)
for more information. Defaults to `false`.
for more information. Defaults to `false`. Only applies to the `/messages`
endpoint, for `/sync` this should be specified in `StateFilter` instead.
not_rooms:
description: A list of room IDs to exclude. If this list is absent then no rooms
are excluded. A matching room will be excluded even if it is listed in the `'rooms'`
Expand Down
Loading