on master help sign in
add possible values of time_range param
commitb7fda2702b2958f4abd1c8f88a067c86029f53e6 authorNoemi Vanyi <sitbackandwait@gmail.com> dateSat 10 Sep 2016, 15:12 (10 years ago) parentfeb25d3
1 file changed+15−15
docs/dev/search_api.rst+15−15
docs/dev/search_api.rst+15−15
@@ -16,18 +16,18 @@ Furthermore, two enpoints ``/`` and ``/search`` are available for querying.
1616Parameters
1717``````````
1818
19−+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
20−| Name | Description | |
21−+==================+====================================================================================================+=============================+
22−| ``q`` | The search query, see :doc:`/user/search_syntax` | required |
23−+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
24−| ``categories`` | Comma separated list, specifies the active search categories | optional |
25−+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
26−| ``engines`` | Comma separated list, specifies the active search engines | optional |
27−+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
28−| ``lang`` | Code of the language | optional (default: ``all``) |
29−+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
30−| ``pageno`` | Search page number | optional (default: ``1``) |
31−+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
32−| ``time_range`` | Time range of search | optional |
33−+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
19++------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
20+| Name | Description | |
21++==================+====================================================================================================+==================================================+
22+| ``q`` | The search query, see :doc:`/user/search_syntax` | required |
23++------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
24+| ``categories`` | Comma separated list, specifies the active search categories | optional |
25++------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
26+| ``engines`` | Comma separated list, specifies the active search engines | optional |
27++------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
28+| ``lang`` | Code of the language | optional (default: ``all``) |
29++------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
30+| ``pageno`` | Search page number | optional (default: ``1``) |
31++------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
32+| ``time_range`` | Time range of search | optional (possible: ``day``, ``month``, ``year``)|
33++------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+