2010-07-26 02:37:36 +00:00
|
|
|
The /camli/enumerate-blobs endpoint enumerates all blobs that the
|
|
|
|
|
server knows about.
|
|
|
|
|
|
|
|
|
|
They're returned in sorted order, sorted by (digest_type,
|
|
|
|
|
digest_value). That is, md5-acbd18db4cc2f85cedef654fccc4a4d8 sorts
|
|
|
|
|
before sha1-0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33 because "m" sorts
|
|
|
|
|
before "s", even though "0" sorts before "a".
|
|
|
|
|
|
|
|
|
|
GET /camli/enumerate-blobs?after=&limit= HTTP/1.1
|
|
|
|
|
Host: example.com
|
|
|
|
|
|
|
|
|
|
URL GET parameters:
|
|
|
|
|
|
|
|
|
|
after optional If provided, only blobs GREATER THAN this
|
|
|
|
|
value are returned.
|
|
|
|
|
|
2011-05-11 13:11:44 +00:00
|
|
|
Can't be used in combination with 'maxwaitsec'
|
|
|
|
|
|
2010-07-26 02:37:36 +00:00
|
|
|
limit optional Limit the number of returned blobrefs. The
|
|
|
|
|
server may have its own lower limit, however,
|
|
|
|
|
so be sure to pay attention to the presence
|
|
|
|
|
of a "continueAfter" key in the JSON response.
|
|
|
|
|
|
2011-02-26 22:03:10 +00:00
|
|
|
maxwaitsec optional The client may send this, an integer max
|
|
|
|
|
number of seconds the client is willing to
|
|
|
|
|
wait for the arrival of blobs. If the
|
|
|
|
|
server supports long-polling (an optional
|
|
|
|
|
feature), then the server will return
|
|
|
|
|
immediately if any blobs or available, else
|
|
|
|
|
it will wait for this number of seconds.
|
2011-03-01 02:11:30 +00:00
|
|
|
It is an error to send this option with a non-
|
|
|
|
|
zero value along with the 'after' option.
|
2011-02-26 22:03:10 +00:00
|
|
|
The server's reply must include
|
|
|
|
|
"canLongPoll" set to true if the server
|
|
|
|
|
supports this feature. Even if the server
|
|
|
|
|
supports long polling, the server may cap
|
|
|
|
|
'maxwaitsec' and wait for less time than
|
|
|
|
|
requested by the client.
|
|
|
|
|
|
2011-05-11 13:11:44 +00:00
|
|
|
Can't be used in combination with 'after'.
|
|
|
|
|
|
2011-02-26 22:03:10 +00:00
|
|
|
|
2010-07-26 02:37:36 +00:00
|
|
|
Response:
|
|
|
|
|
|
|
|
|
|
HTTP/1.1 200 OK
|
|
|
|
|
Content-Type: text/javascript
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
"blobs": [
|
|
|
|
|
{"blobRef": "md5-acbd18db4cc2f85cedef654fccc4a4d8",
|
|
|
|
|
"size": 3},
|
|
|
|
|
{"blobRef": "sha1-0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33",
|
|
|
|
|
"size": 3},
|
|
|
|
|
],
|
2011-03-02 01:25:35 +00:00
|
|
|
"continueAfter": "sha1-0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33",
|
2011-02-26 22:03:10 +00:00
|
|
|
"canLongPoll": true,
|
2010-07-26 02:37:36 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
Response keys:
|
|
|
|
|
|
|
|
|
|
blobs required Array of {"blobRef": BLOBREF, "size": INT_bytes}
|
2010-08-03 04:05:54 +00:00
|
|
|
will be an empty list if no blobs are present.
|
2010-07-26 02:37:36 +00:00
|
|
|
|
2011-02-04 01:06:01 +00:00
|
|
|
continueAfter optional If present, the result is truncated and there are
|
2010-07-26 02:37:36 +00:00
|
|
|
are more blobs after the provided blobref, which
|
2010-08-03 04:05:54 +00:00
|
|
|
should be passed to the next request's "after"
|
|
|
|
|
request parameter.
|
2010-07-26 02:37:36 +00:00
|
|
|
|
2011-02-26 22:03:10 +00:00
|
|
|
canLongPoll optional Set to true (type boolean) if the server supports
|
|
|
|
|
long polling. If not true, the server ignores
|
|
|
|
|
the client's "maxwaitsec" parameter.
|
