diff options
| author | Milo Casagrande <milo.casagrande@linaro.org> | 2014-08-08 17:38:09 +0200 |
|---|---|---|
| committer | Milo Casagrande <milo.casagrande@linaro.org> | 2014-08-08 17:38:09 +0200 |
| commit | 7e147008dc4640f7a356e607799d46adb834023c (patch) | |
| tree | 560b313100ba2022bea3b592e77a7bdfab1f25af /doc | |
| parent | c36178336a78b46351e4be32224983b4b6e5f277 (diff) | |
More doc updates.
Change-Id: I22a8e8dd684bfb022337b5ee6abbc85e53660810
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/count-collection.rst | 4 | ||||
| -rw-r--r-- | doc/intro.rst | 13 |
2 files changed, 9 insertions, 8 deletions
diff --git a/doc/count-collection.rst b/doc/count-collection.rst index 4c5c9c2..516e2c6 100644 --- a/doc/count-collection.rst +++ b/doc/count-collection.rst @@ -25,9 +25,9 @@ GET (ascending). This will be applied only to the first ``sort`` parameter passed. Default -1. :type sort_order: int - :query created_on: Number of days to consider, starting from today + :query date_range: Number of days to consider, starting from today (:ref:`more info <schema_time_date>`). By default consider all results. - :type created_on: int + :type date_range: int :query arch: A type of computer architetcture (like ``arm``, ``arm64``). :type arch: string :query board: The name of a board. diff --git a/doc/intro.rst b/doc/intro.rst index d1fc579..211fa0b 100644 --- a/doc/intro.rst +++ b/doc/intro.rst @@ -99,18 +99,19 @@ A timestamp will be encoded as follows: :: Internally, timestamps are stored in `BSON <http://bsonspec.org/>`_ format. -When using the ``created_on`` parameter in a query, it does not accept a date, but a range of days: +When using the ``date_range`` parameter in a query: .. sourcecode:: http GET /job?date_range=5 HTTP/1.1 The number indicates how many days of data to consider starting from today's -date at ``00:00 UTC``. Internally it will be converted in a timedelta structure: :: +date at ``23:59 UTC`` to ``00:00 UTC`` of the range date. Internally it will be converted in a timedelta structure using the ``created_on`` field: :: - {"created_on": { - "$lt": {"$date": 1407542399000}, - "$gte": {"$date": 1407369600000} + { + "created_on": { + "$lt": {"$date": 1407542399000}, + "$gte": {"$date": 1407369600000} } } @@ -134,4 +135,4 @@ Basic Authentication :: - curl -H 'Authorization: token' https://api.backend.linaro.org + curl -H 'Authorization: token' https://api.backend.linaro.org/job |