From a38af2009f72fc91f3aa4a90a323a050ba8dde06 Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Fri, 7 Jun 2019 10:37:57 -0600 Subject: [PATCH] Apply suggestions from code review Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> --- api/client-server/message_pagination.yaml | 6 +++--- api/client-server/sync.yaml | 4 ++-- specification/client_server_api.rst | 6 +++--- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/api/client-server/message_pagination.yaml b/api/client-server/message_pagination.yaml index c5d7b8fc..3e01437a 100644 --- a/api/client-server/message_pagination.yaml +++ b/api/client-server/message_pagination.yaml @@ -115,14 +115,14 @@ paths: type: array description: |- A list of state events relevant to showing the ``chunk``. For example, if - lazy-loading members is enabled in the filter then this will contain any - applicable membership events. Servers should be careful to not exclude + ``lazy_load_members`` is enabled in the filter then this will contain any + the membership events for the the senders of events in the ``chunk``. Servers should be careful to not exclude membership events which are older than ones already sent to the client. Likewise, clients should be cautious and avoid using older membership events as the current membership event when paginating backwards. Unless ``include_redundant_members`` is ``true``, the server should remove - redundant members which would have already been sent to clients in prior calls + membership events which would have already been sent to clients in prior calls to lazy-loading aware endpoints with the same filter. items: type: object diff --git a/api/client-server/sync.yaml b/api/client-server/sync.yaml index ed9d7420..45829f68 100644 --- a/api/client-server/sync.yaml +++ b/api/client-server/sync.yaml @@ -41,8 +41,8 @@ paths: syncing user's own membership event when they join a room, or when the full state of rooms is requested. 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 (from ``since``), - even if the applicable events are not in the response, regardless as to whether + 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. ``include_redundant_members`` is ignored for limited syncs. operationId: sync diff --git a/specification/client_server_api.rst b/specification/client_server_api.rst index c62740d4..42f34849 100644 --- a/specification/client_server_api.rst +++ b/specification/client_server_api.rst @@ -1286,7 +1286,7 @@ for the ``sender`` of events in the timeline, not all members of a room. Repeated calls to lazy-loading aware endpoints will result in redundant membership events being excluded by default. Clients often track which membership events they already have, therefore making the extra information not as useful to the client. -Clients can always request redundant members by setting ``include_redundant_members`` +Clients can always request redundant membership events by setting ``include_redundant_members`` to true in the filter. Servers should be cautious about which events they consider redundant. Membership @@ -1296,9 +1296,9 @@ as the current membership event for a user. .. Note:: Repeated calls using the same filter to *any* lazy-loading aware endpoint may - result in redundant members being excluded from future calls. For example, a + result in redundant membership events being excluded from future calls. For example, a request to ``/sync`` followed by a request to ``/messages`` may result in a - future call to ``/sync`` excluding members included by the ``/messages`` call. + future call to ``/sync`` excluding membership events returned by the ``/messages`` call. The current endpoints which support lazy-loading room members are: