@ -51,9 +51,12 @@ paths:
name : from name : from
description : |- description : |-
The token to start returning events from. This token can be obtained The token to start returning events from. This token can be obtained
from a `prev_batch` token returned for each room by the sync API, from a `prev_batch` or `next_batch` token returned by the `/sync` endpoint,
or from a `start` or `end` token returned by a previous request or from an `end` token returned by a previous request to this endpoint.
to this endpoint.
This endpoint can also accept a value returned as a `start` token
by a previous request to this endpoint, though servers are not
required to support this. Clients should not rely on the behaviour.
required : true required : true
x-example : "s345_678_333" x-example : "s345_678_333"
- in : query - in : query
@ -61,16 +64,18 @@ paths:
name : to name : to
description : |- description : |-
The token to stop returning events at. This token can be obtained from The token to stop returning events at. This token can be obtained from
a `prev_batch` token returned for each room by the sync endpoint, a `prev_batch` or `next_batch` token returned by the `/sync` endpoint,
or from a `start` or `end` token returned by a previous request to or from an `end` token returned by a previous request to this endpoint.
this endpoint.
required : false required : false
- in : query - in : query
type : string type : string
enum : [ "b" , "f" ] enum : [ "b" , "f" ]
name : dir name : dir
description : |- description : |-
The direction to return events from. The direction to return events from. If this is set to `f`, events
will be returned in chronological order starting at `from`. If it
is set to `b`, events will be returned in *reverse* chronolgical
order, again starting at `from`.
required : true required : true
x-example : "b" x-example : "b"
- in : query - in : query
@ -96,20 +101,29 @@ paths:
start: start:
type : string type : string
description : |- description : |-
The token the pagination starts from. If `dir=b` this will be A token corresponding to the start of `chunk`. This will be the same as
the token supplied in `from`. the value given in `from`.
end: end:
type : string type : string
description : |- description : |-
The token the pagination ends at. If `dir=b` this token should A token corresponding to the end of `chunk`. This token can be passed
be used again to request even earlier events. back to this endpoint to request further events.
If no further events are available (either because we have
reached the start of the timeline, or because the user does
not have permission to see any more events), this property
is omitted from the response.
chunk: chunk:
type : array type : array
description : |- description : |-
A list of room events. The order depends on the `dir` parameter. A list of room events. The order depends on the `dir` parameter.
For `dir=b` events will be in reverse-chronological order, For `dir=b` events will be in reverse-chronological order,
for `dir=f` in chronological order, so that events start for `dir=f` in chronological order. (The exact definition of `chronological`
at the `from` point. is dependent on the server implementation.)
Note that an empty `chunk` does not *necessarily* imply that no more events
are available. Clients should continue to paginate until no `end` property
is returned.
items: items:
"$ref": "../../event-schemas/schema/core-event-schema/room_event.yaml" "$ref": "../../event-schemas/schema/core-event-schema/room_event.yaml"
state: state:
@ -125,6 +139,7 @@ paths:
the membership of those members has not changed. the membership of those members has not changed.
items: items:
$ref : "../../event-schemas/schema/core-event-schema/state_event.yaml" $ref : "../../event-schemas/schema/core-event-schema/state_event.yaml"
required : [ start, chunk]
examples: examples:
application/json : { application/json : {
"start": "t47429-4392820_219380_26003_2265" , "start": "t47429-4392820_219380_26003_2265" ,
Richard van der Hoff
3 years ago
committed by