wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Generalize the token name even more

Browse source
This commit is contained in:
Travis Ralston 2018-08-31 14:22:07 -06:00
parent f299fe023a
commit 835f5de387
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
specification/client_server_api.rst
View file

@ -1023,10 +1023,10 @@ a ``limit`` and ``dir``. Together, these parameters describe the position in a
data set, where ``from`` and ``to`` are known as "stream tokens" matching the
regular expression ``[a-zA-Z0-9.=_-]+``. If supported, the ``dir`` defines the
direction of events to return: either forwards (``f``) or backwards (``b``).
The response contains a ``start`` or ``prev_batch`` token which references the
result set immediately prior to the returned set. The response might additionally
have an ``end`` or ``next_batch`` token to indicate the results after the returned
set.
The response may contain tokens that can be used for retrieving results before
or after the returned set. These tokens may be called `start` or `prev_batch`
for retrieving the previous result set, or `end`, `next_batch` or `next_token`
for retrieving the next result set.
In the following examples, 'START' and 'END' are placeholders to signify the
start and end of the data sets respectively.