diff options
| author | Milo Casagrande <milo.casagrande@linaro.org> | 2014-08-11 11:12:59 +0200 |
|---|---|---|
| committer | Milo Casagrande <milo.casagrande@linaro.org> | 2014-08-11 17:35:15 +0200 |
| commit | f1f69d80a1b56bcf7787ca2e17220dc50786e0cb (patch) | |
| tree | 61bb29d90ecfeba1a48b65972321e4e3efcdff6d /doc | |
| parent | 7e147008dc4640f7a356e607799d46adb834023c (diff) | |
doc: Small fixes.
Change-Id: I8973d80f4b75fb6d13d6e4731569054bc6265c14
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/collections.rst | 2 | ||||
| -rw-r--r-- | doc/count-collection.rst | 12 | ||||
| -rw-r--r-- | doc/intro.rst | 14 |
3 files changed, 26 insertions, 2 deletions
diff --git a/doc/collections.rst b/doc/collections.rst index 6b4e996..262d5ff 100644 --- a/doc/collections.rst +++ b/doc/collections.rst @@ -1,3 +1,5 @@ +.. _collections: + Collections =========== diff --git a/doc/count-collection.rst b/doc/count-collection.rst index 516e2c6..9c832ec 100644 --- a/doc/count-collection.rst +++ b/doc/count-collection.rst @@ -9,12 +9,14 @@ GET Count the elements in all collections or in the provided ``collection``. When using the query parameters, the results will include also the fields - specified. + specified and their values. :param collection: The name of the collection to get the count of. Can be one of ``job``, ``defconfig``, ``boot``. + :type collection: string :reqheader Authorization: The token necessary to authorize the request. + :reqheader Accept-Encoding: Accept the ``gzip`` coding. :query limit: Number of results to return. Default 0 (all results). :type limit: int @@ -36,11 +38,17 @@ GET :type defconfig: string :query job: A job name. :type job: string - :query job_id: A job ID (usually in the form of ``job``-``kernel``). + :query job_id: A job ID (in the form of ``job``-``kernel``). :type job_id: string :query kernel: A kernel name. :type kernel: string + .. note:: + + Not all the query parameters are valid for each collection. Please refer + to the GET method :ref:`documentation <collections>` of the collection to know which parameters + can be used. + **Example Requests** .. sourcecode:: http diff --git a/doc/intro.rst b/doc/intro.rst index 211fa0b..bf146d8 100644 --- a/doc/intro.rst +++ b/doc/intro.rst @@ -136,3 +136,17 @@ Basic Authentication :: curl -H 'Authorization: token' https://api.backend.linaro.org/job + + +Accepted Encodings +------------------ + +The server accepts the ``gzip`` coding for the ``Accept-Encoding`` HTTP header. + +Responses will be compressed using **gzip**. + +.. note:: + + It is highly advised to require responses compression from the server, it + will save considerable amount of transfer time. + |