better API docs && more features in list

1 files changed, 78 insertions, 0 deletions

diff --git a/docs/admin/api.rst b/docs/admin/api.rst
new file mode 100644
index 000000000..94508a28c
--- /dev/null
+++ b/docs/admin/api.rst
@@ -0,0 +1,78 @@
+.. _adminapi:
+
+Administration API
+------------------
+
+Get configuration data
+~~~~~~~~~~~~~~~~~~~~~~
+
+.. code:: sh
+
+    GET /config
+
+Sample response
+```````````````
+
+.. code:: sh
+    
+    {
+      "autocomplete": "", 
+      "categories": [
+        "map", 
+        "it", 
+        "images", 
+      ], 
+      "default_locale": "", 
+      "default_theme": "oscar", 
+      "engines": [
+        {
+          "categories": [
+            "map"
+          ], 
+          "enabled": true, 
+          "name": "openstreetmap", 
+          "shortcut": "osm"
+        }, 
+        {
+          "categories": [
+            "it"
+          ], 
+          "enabled": true, 
+          "name": "arch linux wiki", 
+          "shortcut": "al"
+        }, 
+        {
+          "categories": [
+            "images"
+          ], 
+          "enabled": true, 
+          "name": "google images", 
+          "shortcut": "goi"
+        }, 
+        {
+          "categories": [
+            "it"
+          ], 
+          "enabled": false, 
+          "name": "bitbucket", 
+          "shortcut": "bb"
+        }, 
+      ], 
+      "instance_name": "searx", 
+      "locales": {
+        "de": "Deutsch (German)", 
+        "en": "English", 
+        "eo": "Esperanto (Esperanto)", 
+      }, 
+      "plugins": [
+        {
+          "enabled": true, 
+          "name": "HTTPS rewrite"
+        }, 
+        {
+          "enabled": false, 
+          "name": "Vim-like hotkeys"
+        }
+      ], 
+      "safe_search": 0
+    }