diff options
author | Milo Casagrande <milo.casagrande@linaro.org> | 2015-01-09 17:09:17 +0100 |
---|---|---|
committer | Milo Casagrande <milo.casagrande@linaro.org> | 2015-01-09 17:09:17 +0100 |
commit | f95d6d0bacf62f33afbc8568aca56a1643db10e3 (patch) | |
tree | eeb003025949251f990e40ffa94ef54a1a202f06 | |
parent | 261586f74e4fb5cf3f88617228403f2765ecb7b1 (diff) |
doc: Various updates.
Change-Id: I9cfd7aff86dc3592ce458d5c7a823a91c3e9d090
-rw-r--r-- | doc/collection-batch.rst | 14 | ||||
-rw-r--r-- | doc/collection-count.rst | 14 | ||||
-rw-r--r-- | doc/collection-version.rst | 2 | ||||
-rw-r--r-- | doc/collections.rst | 8 | ||||
-rw-r--r-- | doc/intro.rst | 4 | ||||
-rw-r--r-- | doc/schema-batch.rst | 4 | ||||
-rw-r--r-- | doc/schema-boot.rst | 2 | ||||
-rw-r--r-- | doc/schema-defconfig.rst | 4 | ||||
-rw-r--r-- | doc/schema-job.rst | 2 | ||||
-rw-r--r-- | doc/schema-lab.rst | 4 |
10 files changed, 31 insertions, 27 deletions
diff --git a/doc/collection-batch.rst b/doc/collection-batch.rst index a549ed0..a9ea28c 100644 --- a/doc/collection-batch.rst +++ b/doc/collection-batch.rst @@ -3,7 +3,7 @@ batch ----- -This is not a real collection. It is instead used to perform a series of operations in batch: if you have more than one request to perform, instead of +This is not a real resource. It is instead used to perform a series of operations in batch: if you have more than one request to perform, instead of sending each request on its own, send a single batch operation request specifying all your requests. @@ -12,7 +12,7 @@ It works by receiving a ``POST`` request with the operations to perform. .. note:: At the moment the batch operator can perform only GET operations on - the available collections. + the available resources. GET *** @@ -33,14 +33,14 @@ POST :reqjsonarr string method: The method of the request. Only ``GET`` is supported. :reqjsonarr string operation_id: An identification for this request opearation. - :reqjsonarr string collection: On which collection the request should be + :reqjsonarr string resource: On which resource the request should be performed. - :reqjsonarr string document_id: The ID of a document in the collection. For - the ``count`` collection, this is used to identify on which collection to + :reqjsonarr string document_id: The ID of a document in the resource. For + the ``count`` resource, this is used to identify on which resource to perform the count. :reqjsonarr string query: The query to perform as a series of ``key=value`` pairs separated by the ampersand ("&") character. The keys must be - the same specified in each collections query parameters. + the same specified in each resources query parameters. :resjsonarr int code: The HTTP code of the response. :resjsonarr array result: The list of result objects for each operation in the batch. If the ``operation_id`` parameter was specified, it will be included @@ -104,7 +104,7 @@ POST "result": [ { "count": 5, - "collection": "boot" + "resource": "boot" } ] }, diff --git a/doc/collection-count.rst b/doc/collection-count.rst index b12e30d..d3ec660 100644 --- a/doc/collection-count.rst +++ b/doc/collection-count.rst @@ -4,13 +4,13 @@ count GET *** -.. http:get:: /count/(string:collection) +.. http:get:: /count/(string:resource) - Count the elements in all collections or in the provided ``collection``. + Count the elements in all resources or in the provided ``resource``. - :param collection: The name of the collection to get the count of. + :param resource: The name of the resource to get the count of. Can be one of ``boot``, ``defconfig``, ``job``. - :type collection: string + :type resource: string :reqheader Authorization: The token necessary to authorize the request. :reqheader Accept-Encoding: Accept the ``gzip`` coding. @@ -46,9 +46,9 @@ GET .. 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. + Not all the query parameters are valid for each resource. Please refer + to the GET method :ref:`documentation <collections>` of the resource to + know which parameters can be used. **Example Requests** diff --git a/doc/collection-version.rst b/doc/collection-version.rst index f844c09..7b51453 100644 --- a/doc/collection-version.rst +++ b/doc/collection-version.rst @@ -16,7 +16,7 @@ GET .. note:: - This collection does not require authentication. + This resource does not require authentication. **Example Requests** diff --git a/doc/collections.rst b/doc/collections.rst index b1bc434..98284e9 100644 --- a/doc/collections.rst +++ b/doc/collections.rst @@ -1,7 +1,11 @@ .. _collections: -Collections -=========== +Resources +========= + +.. note:: + + Some of the follwing resources can be accessed also using their pluarl form. For more info refer to each resource documentation. .. toctree:: :maxdepth: 2 diff --git a/doc/intro.rst b/doc/intro.rst index 28f8419..5ffe396 100644 --- a/doc/intro.rst +++ b/doc/intro.rst @@ -82,7 +82,7 @@ API access is exclusively over HTTPS and accessed via the Data is sent and received **only** in JSON format. -For more info about the collections schema, refer to their :ref:`schema declaration <schema>`. +For more info about the resources schema, refer to their :ref:`schema declaration <schema>`. .. _intro_schema_results: @@ -139,7 +139,7 @@ The syntax to define a ranged search is as follows: ``field`` and ``value`` are separated by a comma (``,``). -The following example will search the ``boot`` collection for boot reports whose +The following example will search the ``boot`` resource for boot reports whose ``retries`` value is between ``2`` and ``4``: .. sourcecode:: http diff --git a/doc/schema-batch.rst b/doc/schema-batch.rst index bb984d6..ee6194b 100644 --- a/doc/schema-batch.rst +++ b/doc/schema-batch.rst @@ -24,7 +24,7 @@ A batch request object. }, "collection": { "type": "string", - "description": "The collection where to perform the operation" + "description": "The resource where to perform the operation" }, "document_id": { "type": "string", @@ -32,7 +32,7 @@ A batch request object. }, "query": { "type": "string", - "description": "A key=value pairs, separated by the ampersand character, that define the query to perform on the collection" + "description": "A key=value pairs, separated by the ampersand character, that define the query to perform on the resource" } } } diff --git a/doc/schema-boot.rst b/doc/schema-boot.rst index fdac8fd..a983916 100644 --- a/doc/schema-boot.rst +++ b/doc/schema-boot.rst @@ -400,7 +400,7 @@ Notes More Info ********* -* :ref:`Boot collection <collection_boot>` +* :ref:`Boot resource <collection_boot>` * :ref:`Defconfig schema <schema_defconfig>` * :ref:`API results <intro_schema_results>` * :ref:`Schema time and date <intro_schema_time_date>` diff --git a/doc/schema-defconfig.rst b/doc/schema-defconfig.rst index 21c49ef..c6e0c65 100644 --- a/doc/schema-defconfig.rst +++ b/doc/schema-defconfig.rst @@ -175,7 +175,7 @@ POST The following schema covers the data that should be available in a build JSON data file sent to the server. -The ``defconfig`` collection does not support POST requests. This schema is +The ``defconfig`` resource does not support POST requests. This schema is placed here as a reference document in order to provide correct data to the server. @@ -321,6 +321,6 @@ Notes More Info ********* -* :ref:`Defconfig collection <collection_defconfig>` +* :ref:`Defconfig resource <collection_defconfig>` * :ref:`API results <intro_schema_results>` * :ref:`Schema time and date <intro_schema_time_date>` diff --git a/doc/schema-job.rst b/doc/schema-job.rst index c3c1d80..878fa21 100644 --- a/doc/schema-job.rst +++ b/doc/schema-job.rst @@ -145,6 +145,6 @@ Notes More Info ********* -* :ref:`Job collection <collection_job>` +* :ref:`Job resource <collection_job>` * :ref:`API results <intro_schema_results>` * :ref:`Schema time and date <intro_schema_time_date>` diff --git a/doc/schema-lab.rst b/doc/schema-lab.rst index b6c8c89..6b80afd 100644 --- a/doc/schema-lab.rst +++ b/doc/schema-lab.rst @@ -5,7 +5,7 @@ lab The ``name`` of the lab mut be a unique value among all the registered labs. Use a short but descriptive name to identify the lab, since this value will be used -to perform POST request :ref:`on the boot collection <collection_boot_post>`. +to perform POST request :ref:`on the boot resource <collection_boot_post>`. As a rule of thumbs for creating a lab ``name``: @@ -240,7 +240,7 @@ POST More Info ********* -* :ref:`Lab collection <collection_lab>` +* :ref:`Lab resource <collection_lab>` * :ref:`Defconfig schema <schema_defconfig>` * :ref:`API results <intro_schema_results>` * :ref:`Schema time and date <intro_schema_time_date>` |