diff options
| author | Adam Tauber <asciimoo@gmail.com> | 2016-07-10 08:28:00 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-07-10 08:28:00 +0200 |
| commit | 7bd30fd21bbc23c485ac9fd77795314edb5dc665 (patch) | |
| tree | 997b66dc3f1ab2ffb1bfbfaf551a00e8777a2306 /docs/dev/search_api.rst | |
| parent | 3e351e3b9f819d5383fd1ebafd906fdbe0c3d086 (diff) | |
| parent | 521f398709ea481fdf55f1e4c111f063f91fa8c0 (diff) | |
Merge pull request #614 from kvch/gh-pages
documentation updates
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. |