Apply suggestions from code review

Co-Authored-By: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
pull/977/head
Travis Ralston 5 years ago committed by GitHub
parent e4339fd687
commit a38af2009f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -115,14 +115,14 @@ paths:
type: array type: array
description: |- description: |-
A list of state events relevant to showing the ``chunk``. For example, if 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 ``lazy_load_members`` is enabled in the filter then this will contain any
applicable membership events. Servers should be careful to not exclude 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. membership events which are older than ones already sent to the client.
Likewise, clients should be cautious and avoid using older membership Likewise, clients should be cautious and avoid using older membership
events as the current membership event when paginating backwards. events as the current membership event when paginating backwards.
Unless ``include_redundant_members`` is ``true``, the server should remove 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. to lazy-loading aware endpoints with the same filter.
items: items:
type: object type: object

@ -41,8 +41,8 @@ paths:
syncing user's own membership event when they join a room, or when the 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 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``, 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``), the server MUST return membership events for events in the gap (between ``since`` and the start of the returned timeline),
even if the applicable events are not in the response, regardless as to whether regardless as to whether
or not they are redundant. ``include_redundant_members`` is ignored for limited or not they are redundant. ``include_redundant_members`` is ignored for limited
syncs. syncs.
operationId: sync operationId: sync

@ -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 Repeated calls to lazy-loading aware endpoints will result in redundant membership
events being excluded by default. Clients often track which membership events they 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. 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. to true in the filter.
Servers should be cautious about which events they consider redundant. Membership Servers should be cautious about which events they consider redundant. Membership
@ -1296,9 +1296,9 @@ as the current membership event for a user.
.. Note:: .. Note::
Repeated calls using the same filter to *any* lazy-loading aware endpoint may 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 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: The current endpoints which support lazy-loading room members are:

Loading…
Cancel
Save