List the endpoints which are lazy-loading aware

pull/977/head
Travis Ralston 6 years ago
parent 34d6c1f4ad
commit b67161cf97

@ -30,7 +30,12 @@ allOf:
``include_redundant_members`` to change this behaviour). ``include_redundant_members`` to change this behaviour).
Only applicable when filtering state events, such as the 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: include_redundant_members:
type: boolean type: boolean
description: |- description: |-
@ -45,7 +50,7 @@ allOf:
is ``false`` this field is ignored. is ``false`` this field is ignored.
Only applicable when filtering state events, such as the 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: not_rooms:
description: A list of room IDs to exclude. If this list is absent then no 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'`` are excluded. A matching room will be excluded even if it is listed in the ``'rooms'``

@ -34,6 +34,9 @@ paths:
This API returns a number of events that happened just before and This API returns a number of events that happened just before and
after the specified event. This allows clients to get the context after the specified event. This allows clients to get the context
surrounding an event. surrounding an event.
*Note*: this endpoint supports lazy-loading. See `Filtering <#filtering>`_
for more information.
operationId: getEventContext operationId: getEventContext
security: security:
- accessToken: [] - accessToken: []

@ -33,6 +33,9 @@ paths:
description: |- description: |-
This API returns a list of message and state events for a room. It uses This API returns a list of message and state events for a room. It uses
pagination query parameters to paginate history in the room. pagination query parameters to paginate history in the room.
*Note*: this endpoint supports lazy-loading. See `Filtering <#filtering>`_
for more information.
operationId: getRoomEvents operationId: getRoomEvents
security: security:
- accessToken: [] - accessToken: []
@ -120,7 +123,7 @@ paths:
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 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: items:
type: object type: object
title: RoomStateEvent title: RoomStateEvent

@ -34,6 +34,9 @@ paths:
Clients use this API when they first log in to get an initial snapshot 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 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. incremental deltas to the state, and to receive new messages.
*Note*: this endpoint supports lazy-loading. See `Filtering <#filtering>`_
for more information.
operationId: sync operationId: sync
security: security:
- accessToken: [] - accessToken: []

Loading…
Cancel
Save