Skip to content

Commit

Permalink
Expiring pagination continuation tokens (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
sampsyo committed Nov 6, 2014
1 parent fe9da0e commit 368b0d3
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,13 @@ continued responses **MUST** be the full sequence of resources in the
collection (i.e., no overlapping and no gaps), provided that the collection is
not modified during the sequence.

A continuation token is not guaranteed to be useful after a single use. Once a
token is used in a request, the server **MAY** respond to subsequent requests
with the same token with an HTTP 410 "Gone" error. The server may also
invalidate unused tokens after an implementation-defined expiration
period. (This is critical for servers that retain state for each in-progress
pagination sequence.)

The client **MAY** include a ``limit`` parameter (an integer) with a
collection ``GET`` request. The server **MUST** respond with *at most* that
number of resources, although it may return fewer. (A ``continue`` token must
Expand Down

0 comments on commit 368b0d3

Please sign in to comment.