From 1c7a6a9c7fa2b47877ce8790ea5e5c588df5fa90 Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Mon, 31 Aug 2020 15:16:55 -0600 Subject: [PATCH] Attempt to clarify how the `state` restriction works for lazy-loading --- api/client-server/sync.yaml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/api/client-server/sync.yaml b/api/client-server/sync.yaml index 1bbe7549..35134fad 100644 --- a/api/client-server/sync.yaml +++ b/api/client-server/sync.yaml @@ -42,12 +42,15 @@ paths: full state of rooms is requested, to aid discovering the user's avatar & displayname. - Like other members, the user's own membership event is eligible + Further, like other members, the user's own membership event is eligible for being considered redundant by the server. When a sync is ``limited``, the server MUST return membership events for events in the gap (between ``since`` and the start of the returned timeline), regardless - as to whether or not they are redundant. This ensures that joins/leaves + as to whether or not they are redundant. This ensures that joins/leaves and profile changes which occur during the gap are not lost. + + Note that the default behaviour of ``state`` is to include all membership + events, alongside other state, when lazy-loading is not enabled. operationId: sync security: - accessToken: []