From 556097ec5f6d4b805675e283ad5f4f4105442714 Mon Sep 17 00:00:00 2001 From: drebs Date: Sun, 21 Jan 2018 15:15:31 -0200 Subject: [doc] improve blobs streaming documentation - move stream api doc to api section - refactor section structure of blobs sync doc page - improve wording a bit here and there --- docs/api/blobs-server.rst | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'docs/api') diff --git a/docs/api/blobs-server.rst b/docs/api/blobs-server.rst index 0b9c3898..71b06eae 100644 --- a/docs/api/blobs-server.rst +++ b/docs/api/blobs-server.rst @@ -33,6 +33,7 @@ path method action accepte of flags should be sent in the body of the request. ``/blobs/{uuid}/{blob_id}`` ``DELETE`` Delete a blob. ``namespace`` +``/stream/{uuid}`` ``POST`` Stream a set of blobs. ``namespace``, ``direction`` =========================== ========== ================================= ============================================ The Blobs service supports *namespaces*. All requests can be modified by the @@ -52,6 +53,11 @@ When downloading blobs (that is, when using the ``GET`` HTTP method), you can send the ``Range`` HTTP header in the request, which will result in the server returning only the requested range of the blob. +When streaming, the ``direction`` parameter is mandatory and indicates whether +this is an upstream (``upload``) or a downstream (``download``). The +``namespace`` parameter is also accepted when streaming and all blobs in the +same stream are considered to be from the same namespace. + .. _incoming-http-api: Local Incoming Box HTTP API -- cgit v1.2.3