Browse Source

add possible values of time_range param

Noemi Vanyi 8 years ago
parent
commit
daf736f1dd
1 changed files with 15 additions and 15 deletions
  1. 15 15
      docs/dev/search_api.rst

+ 15 - 15
docs/dev/search_api.rst

@@ -16,18 +16,18 @@ Furthermore, two enpoints ``/`` and ``/search`` are available for querying.
 Parameters
 ``````````
 
-+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
-| Name             | Description                                                                                        |                             |
-+==================+====================================================================================================+=============================+
-| ``q``            | The search query, see :doc:`/user/search_syntax`                                                   | required                    |
-+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
-| ``categories``   | Comma separated list, specifies the active search categories                                       | optional                    |
-+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
-| ``engines``      | Comma separated list, specifies the active search engines                                          | optional                    |
-+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
-| ``lang``         | Code of the language                                                                               | optional (default: ``all``) |
-+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
-| ``pageno``       | Search page number                                                                                 | optional (default: ``1``)   |
-+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
-| ``time_range``   | Time range of search                                                                               | optional                    |
-+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
++------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
+| Name             | Description                                                                                        |                                                  |
++==================+====================================================================================================+==================================================+
+| ``q``            | The search query, see :doc:`/user/search_syntax`                                                   | required                                         |
++------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
+| ``categories``   | Comma separated list, specifies the active search categories                                       | optional                                         |
++------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
+| ``engines``      | Comma separated list, specifies the active search engines                                          | optional                                         |
++------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
+| ``lang``         | Code of the language                                                                               | optional (default: ``all``)                      |
++------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
+| ``pageno``       | Search page number                                                                                 | optional (default: ``1``)                        |
++------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+
+| ``time_range``   | Time range of search                                                                               | optional (possible: ``day``, ``month``, ``year``)|
++------------------+----------------------------------------------------------------------------------------------------+--------------------------------------------------+