From dc7fc0309e381ca55444bdd9baacd1dcda90f62f Mon Sep 17 00:00:00 2001 From: Benjamin Saunders Date: Tue, 12 Jul 2016 20:38:53 -0700 Subject: [PATCH] Add missing "to" parameter to /messages Signed-off-by: Benjamin Saunders --- api/client-server/message_pagination.yaml | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/api/client-server/message_pagination.yaml b/api/client-server/message_pagination.yaml index 8829b9db..f50f0f45 100644 --- a/api/client-server/message_pagination.yaml +++ b/api/client-server/message_pagination.yaml @@ -34,9 +34,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"] @@ -61,7 +72,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