Skip to content

Commit c89e5bf

Browse files
authored
Merge pull request #2754 from matrix-org/travis/ll/clarification
Attempt to clarify how the `state` restriction works for lazy-loading
2 parents 3943e63 + 1bac9fb commit c89e5bf

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

api/client-server/sync.yaml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,15 @@ paths:
4242
full state of rooms is requested, to aid discovering the user's avatar &
4343
displayname.
4444
45-
Like other members, the user's own membership event is eligible
45+
Further, like other members, the user's own membership event is eligible
4646
for being considered redundant by the server. When a sync is ``limited``,
4747
the server MUST return membership events for events in the gap
4848
(between ``since`` and the start of the returned timeline), regardless
49-
as to whether or not they are redundant. This ensures that joins/leaves
49+
as to whether or not they are redundant. This ensures that joins/leaves
5050
and profile changes which occur during the gap are not lost.
51+
52+
Note that the default behaviour of ``state`` is to include all membership
53+
events, alongside other state, when lazy-loading is not enabled.
5154
operationId: sync
5255
security:
5356
- accessToken: []
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Clarify the behaviour of ``state`` for ``/sync`` with lazy-loading.

0 commit comments

Comments
 (0)