diff options
| author | Noemi Vanyi <sitbackandwait@gmail.com> | 2016-07-09 22:31:21 +0200 |
|---|---|---|
| committer | Noemi Vanyi <sitbackandwait@gmail.com> | 2016-07-09 22:31:21 +0200 |
| commit | 2ad8715b3282557d39da21721487ff85683b1219 (patch) | |
| tree | 5d40b42c696b7064e062fdbb2786211a6bf6a8c9 /docs/dev/search_api.rst | |
| parent | 9f7cb4359ccc85d5b644dacc0745220700158b0b (diff) | |
better API docs && more features in list
Diffstat (limited to 'docs/dev/search_api.rst')
| -rw-r--r-- | docs/dev/search_api.rst | 19 |
1 files changed, 13 insertions, 6 deletions
diff --git a/docs/dev/search_api.rst b/docs/dev/search_api.rst index cd86fd71c..59d3c825f 100644 --- a/docs/dev/search_api.rst +++ b/docs/dev/search_api.rst @@ -1,13 +1,20 @@ Search API ========== -Search API endpoints: ``/``, ``/search`` -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The search supports both ``GET`` and ``POST``. However, using ``GET`` the parameters of the request remain hidden. So it is advised to use ``GET`` for querying. -Endpoints have equivalent functionality. +Furthermore, two enpoints ``/`` and ``/search`` are available for querying. + +.. code:: sh + + GET / + +.. code:: sh + + GET /search Parameters -^^^^^^^^^^ +`````````` +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+ | Name | Description | | @@ -18,7 +25,7 @@ Parameters +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+ | ``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``) | +------------------+----------------------------------------------------------------------------------------------------+-----------------------------+ - -Both ``GET`` and ``POST`` methods are supported. |