Skip to content

Commit

Permalink
Explicitely document that only limit param may change when using `o…
Browse files Browse the repository at this point in the history
…ffset` (#68); r=rfk

Document how GET params should behave when repeating requests with 'offset'
  • Loading branch information
grigoryk authored and rfk committed Jan 24, 2017
1 parent 0add41b commit 32cdd00
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion source/storage/apis-1.5.rst
Original file line number Diff line number Diff line change
Expand Up @@ -915,6 +915,10 @@ To fetch additional items, repeat the request using the value from
process should be repeated; if it does not then all available items have been
returned.

When repeating requests and specifying an **offset** parameter, it is important to
maintain any parameters which may change underlying data or its ordering.
Other than the **offset**, one may only change the **limit** parameter.

To guard against other clients making concurrent changes to the
collection, this technique should always be combined with the
**X-If-Unmodified-Since** header as shown below::
Expand All @@ -939,7 +943,7 @@ collection, this technique should always be combined with the

.. _syncstorage_batch_upload:

Example: uploading a large batch of items
Example: uploading a large batch of items
-----------------------------------------

The syncstorage server allows several upload requests to be combined into a
Expand Down

0 comments on commit 32cdd00

Please sign in to comment.