diff --git a/api/client-server/definitions/room_event_filter.yaml b/api/client-server/definitions/room_event_filter.yaml index 35b3edf9..4790643e 100644 --- a/api/client-server/definitions/room_event_filter.yaml +++ b/api/client-server/definitions/room_event_filter.yaml @@ -30,7 +30,12 @@ allOf: ``include_redundant_members`` to change this behaviour). Only applicable when filtering state events, such as the - ``state`` section of a ``/sync`` or ``/messages`` response. + ``state`` section of a lazy-loading aware endpoint. + + The endpoints which support lazy-loading are: + `/sync <#get-matrix-client-%CLIENT_RELEASE_LABEL%-sync>`_, + `/messages <#get-matrix-client-%CLIENT_RELEASE_LABEL%-rooms-roomid-messages>`_, + and `/context <#get-matrix-client-%CLIENT_RELEASE_LABEL%-rooms-roomid-context-eventid>`_. include_redundant_members: type: boolean description: |- @@ -45,7 +50,7 @@ allOf: is ``false`` this field is ignored. Only applicable when filtering state events, such as the - ``state`` section of a ``/sync`` or ``/messages`` response. + ``state`` section of a lazy-loading aware endpoint. 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'`` diff --git a/api/client-server/event_context.yaml b/api/client-server/event_context.yaml index 91da3cf4..c0f391e5 100644 --- a/api/client-server/event_context.yaml +++ b/api/client-server/event_context.yaml @@ -34,6 +34,9 @@ paths: This API returns a number of events that happened just before and after the specified event. This allows clients to get the context surrounding an event. + + *Note*: this endpoint supports lazy-loading. See `Filtering <#filtering>`_ + for more information. operationId: getEventContext security: - accessToken: [] diff --git a/api/client-server/message_pagination.yaml b/api/client-server/message_pagination.yaml index ff6d970d..716afb65 100644 --- a/api/client-server/message_pagination.yaml +++ b/api/client-server/message_pagination.yaml @@ -33,6 +33,9 @@ paths: description: |- This API returns a list of message and state events for a room. It uses pagination query parameters to paginate history in the room. + + *Note*: this endpoint supports lazy-loading. See `Filtering <#filtering>`_ + for more information. operationId: getRoomEvents security: - accessToken: [] @@ -120,7 +123,7 @@ paths: Unless ``include_redundant_members`` is ``true``, the server should remove redundant members which would have already been sent to clients in prior calls - to ``/messages`` or ``/sync`` with the same filter. + to lazy-loading aware endpoints with the same filter. items: type: object title: RoomStateEvent diff --git a/api/client-server/sync.yaml b/api/client-server/sync.yaml index f204152a..87e7bf74 100644 --- a/api/client-server/sync.yaml +++ b/api/client-server/sync.yaml @@ -34,6 +34,9 @@ paths: Clients use this API when they first log in to get an initial snapshot of the state on the server, and then continue to call this API to get incremental deltas to the state, and to receive new messages. + + *Note*: this endpoint supports lazy-loading. See `Filtering <#filtering>`_ + for more information. operationId: sync security: - accessToken: []