forked from Icycoide/searxng
[enh] initial structure
This commit is contained in:
commit
1d6597b407
14 changed files with 1404 additions and 0 deletions
24
docs/dev/search_api.rst
Normal file
24
docs/dev/search_api.rst
Normal file
|
@ -0,0 +1,24 @@
|
|||
Search API
|
||||
==========
|
||||
|
||||
Search API endpoints: ``/``, ``/search``
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Endpoints have equivalent functionality.
|
||||
|
||||
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 |
|
||||
+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
|
||||
| ``pageno`` | Search page number | optional (default: ``1``) |
|
||||
+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
|
||||
|
||||
Both ``GET`` and ``POST`` methods are supported.
|
Loading…
Add table
Add a link
Reference in a new issue