From 5795c1971f5931cd7ff0361b7c47f9425a76a112 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Mon, 25 Jul 2022 16:59:55 +0200 Subject: [PATCH] [fix] update documentation of Search-API (/dev) This patch fixes a leftover from [#1548], the list of the plugins was not up-to-date: - HTTPS_rewrite has been removed (247c46c6b) - DOAI_rewrite is named 'Open_Access_DOI_rewrite' (575159b) [#1548] https://github.com/searxng/searxng/pull/1548 Signed-off-by: Markus Heiser --- docs/dev/search_api.rst | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/docs/dev/search_api.rst b/docs/dev/search_api.rst index 527259269..3a56b9991 100644 --- a/docs/dev/search_api.rst +++ b/docs/dev/search_api.rst @@ -91,22 +91,32 @@ Parameters ``enabled_plugins`` : optional List of enabled plugins. - :default: ``HTTPS_rewrite``, ``Self_Informations``, - ``Search_on_category_select``, ``Tracker_URL_remover`` + :default: + ``Hash_plugin``, ``Search_on_category_select``, + ``Self_Informations``, ``Tracker_URL_remover``, + ``Ahmia_blacklist`` - :values: ``DOAI_rewrite``, ``HTTPS_rewrite``, ``Infinite_scroll``, - ``Vim-like_hotkeys``, ``Self_Informations``, ``Tracker_URL_remover``, - ``Search_on_category_select``, ``Hostname_replace``, ``Tor_check_plugin`` + :values: + .. enabled by default + + ``Hash_plugin``, ``Search_on_category_select``, + ``Self_Informations``, ``Tracker_URL_remover``, + ``Ahmia_blacklist``, + + .. disabled by default + + ``Hostname_replace``, ``Open_Access_DOI_rewrite``, + ``Vim-like_hotkeys``, ``Tor_check_plugin`` ``disabled_plugins``: optional List of disabled plugins. - :default: ``DOAI_rewrite``, ``Infinite_scroll``, ``Vim-like_hotkeys``, - ``Hostname_replace``, ``Tor_check_plugin`` + :default: + ``Hostname_replace``, ``Open_Access_DOI_rewrite``, + ``Vim-like_hotkeys``, ``Tor_check_plugin`` - :values: ``DOAI_rewrite``, ``HTTPS_rewrite``, ``Infinite_scroll``, - ``Vim-like_hotkeys``, ``Self_Informations``, ``Tracker_URL_remover``, - ``Search_on_category_select``, ``Hostname_replace``, ``Tor_check_plugin`` + :values: + see values from ``enabled_plugins`` ``enabled_engines`` : optional : *all* :origin:`engines ` List of enabled engines.