Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-03 10:14:10 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #348 from Ralith/room-messages

Browse source 
Add missing "to" parameter to /messages
This commit is contained in:
Richard van der Hoff 2016-07-13 11:01:56 +01:00 committed by GitHub
parent d8a47dbb5d dc7fc0309e
commit 7080fd0618
1 changed files with 13 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
api/client-server/message_pagination.yaml
View file

@ -47,9 +47,20 @@ paths:
name: from
description: |-
The token to start returning events from. This token can be obtained
from the initial sync API.
from a ``prev_batch`` token returned for each room by the sync API,
or from a ``start`` or ``end`` token returned by a previous request
to this endpoint.
required: true
x-example: "s345_678_333"
- in: query
type: string
name: to
description: |-
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,
or from a ``start`` or ``end`` token returned by a previous request to
this endpoint.
required: false
- in: query
type: string
enum: ["b", "f"]
@ -74,7 +85,7 @@ paths:
start:
type: string
description: |-
The token to start paginating from. If ``dir=b`` this will be
The token the pagination starts from. If ``dir=b`` this will be
the token supplied in ``from``.
end:
type: string