summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordrebs <drebs@riseup.net>2017-11-03 12:06:55 -0200
committerdrebs <drebs@riseup.net>2017-11-03 12:06:55 -0200
commitf3b4de0bed7f5ae622f19324349cc4d6e834390e (patch)
treefa4426aab619f03eadec84dd4b35f30e770352b4
parent2aced0817393b1ed26e0704b0a50f6de41c76d6a (diff)
[doc] improve blobs http api description
-rw-r--r--docs/api/blobs-server.rst19
-rw-r--r--docs/reference/blobs/server.rst4
2 files changed, 15 insertions, 8 deletions
diff --git a/docs/api/blobs-server.rst b/docs/api/blobs-server.rst
index 3efe86bd..47ab7b74 100644
--- a/docs/api/blobs-server.rst
+++ b/docs/api/blobs-server.rst
@@ -3,10 +3,10 @@ Blobs Server-side HTTP API
Soledad Server provides two different REST APIs for interacting with blobs:
-* A *public* :ref:`blobs-http-api`, providing the *Blobs* service for Soledad
+* A :ref:`blobs-http-api`, providing the *Blobs* service for Soledad
Client (i.e. actual users of the infrastructure).
-* A *local* :ref:`incoming-http-api`, providing the delivery part of the
+* A :ref:`incoming-http-api`, providing the delivery part of the
:ref:`incoming-box` service, currently used for the MX mail delivery.
Authentication is handled differently for each of the endpoints, see
@@ -35,15 +35,22 @@ path method action accepte
``/blobs/{uuid}/{blob_id}`` ``DELETE`` Delete a blob. ``namespace``
=========================== ========== ================================= ============================================
+When listing blobs, results can be filtered and ordered by using different
+query string parameters. See the table above for accepted query string fields
+for each action.
+
The Blobs service supports *namespaces*. All requests can be modified by the
``namespace`` query string parameter, and the results will be restricted to
a certain namespace. When no namespace explicitelly given, the ``default``
namespace is used.
-When listing blobs, the results can be filtered by flag and/or ordered by date
-using the ``filter_flag`` and ``order_by`` query string parameters. The
-possible values for ``order_by`` are ``date`` or ``+date`` for increasing
-order, or ``-date`` for decreasing order.
+Listing results can be filtered by flags using the ``filter_flag`` query string
+parameter. Currently valid values for flags ``PENDING``, ``PROCESSING``,
+``PROCESSED``, and ``FAILED``.
+
+Also, results can be ordered by date using the ``order_by`` query string
+parameters. The possible values for ``order_by`` are ``date`` or ``+date`` for
+increasing order, or ``-date`` for decreasing order.
.. _incoming-http-api:
diff --git a/docs/reference/blobs/server.rst b/docs/reference/blobs/server.rst
index cda0b95c..fac0ad03 100644
--- a/docs/reference/blobs/server.rst
+++ b/docs/reference/blobs/server.rst
@@ -9,10 +9,10 @@ HTTP APIs
Soledad Server provides two different REST APIs for interacting with blobs:
-* A *public* :ref:`blobs-http-api`, providing the *Blobs* service for Soledad
+* A :ref:`blobs-http-api`, providing the *Blobs* service for Soledad
Client (i.e. actual users of the infrastructure).
-* A *local* :ref:`incoming-http-api`, providing the delivery part of the
+* A :ref:`incoming-http-api`, providing the delivery part of the
:ref:`incoming-box` service, currently used for the MX mail delivery.
Authentication is handled differently for each of the endpoints, see