aboutsummaryrefslogtreecommitdiff
path: root/doc/drafts/k2v-spec.md
diff options
context:
space:
mode:
authorAlex Auvolat <alex@adnab.me>2023-01-11 12:03:17 +0100
committerAlex Auvolat <alex@adnab.me>2023-01-11 12:03:17 +0100
commitba384e61c0951036b0c4fb394011f3498abf67ca (patch)
tree1530807dbf076c0834cd9bd391bee5a2a21f1a58 /doc/drafts/k2v-spec.md
parent09a3dad0f2c1641e4e300809dbdb3599b32efc03 (diff)
downloadgarage-ba384e61c0951036b0c4fb394011f3498abf67ca.tar.gz
garage-ba384e61c0951036b0c4fb394011f3498abf67ca.zip
PollRange: return immediately if no seen marker is provided
Diffstat (limited to 'doc/drafts/k2v-spec.md')
-rw-r--r--doc/drafts/k2v-spec.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/drafts/k2v-spec.md b/doc/drafts/k2v-spec.md
index a335aee3..b3c79c08 100644
--- a/doc/drafts/k2v-spec.md
+++ b/doc/drafts/k2v-spec.md
@@ -723,6 +723,13 @@ The query body is a JSON object consisting of the following fields:
The timeout can be set to any number of seconds, with a maximum of 600 seconds (10 minutes).
+If no seen marker is known by the caller, it can do a PollRange call
+without specifying `seenMarker`. In this case, the PollRange call will
+complete immediately, and return the current content of the range (which
+can be empty) and a seen marker to be used in further PollRange calls. This
+is the only case in which PollRange might return an HTTP 200 with an empty
+set of items.
+
The response is either:
- A HTTP 304 NOT MODIFIED response with an empty body, if the timeout expired and no changes occurred