From ecb7d0bb5166c435a89f924b3e67b8aeb2b68243 Mon Sep 17 00:00:00 2001
From: Jakob Borg <jakob@nym.se>
Date: Tue, 27 Oct 2015 08:46:51 +0100
Subject: [PATCH] REST changes around logging

---
 rest/system-debug-get.rst  | 34 ++++++++++++++++++++++++++++++++++
 rest/system-debug-post.rst | 13 +++++++++++++
 rest/system-error-get.rst  |  6 ++++--
 rest/system-log-get.rst    | 17 +++++++++++++++++
 4 files changed, 68 insertions(+), 2 deletions(-)
 create mode 100644 rest/system-debug-get.rst
 create mode 100644 rest/system-debug-post.rst
 create mode 100644 rest/system-log-get.rst

diff --git a/rest/system-debug-get.rst b/rest/system-debug-get.rst
new file mode 100644
index 000000000..30a1ebd50
--- /dev/null
+++ b/rest/system-debug-get.rst
@@ -0,0 +1,34 @@
+GET /rest/system/debug
+======================
+
+.. versionadded:: 0.12.0
+
+Returns the set of debug facilities and which of them are currently enabled.
+
+.. code-block:: json
+
+    {
+      "enabled": [
+        "beacon"
+      ],
+      "facilities": {
+        "beacon": "Multicast and broadcast discovery",
+        "config": "Configuration loading and saving",
+        "connections": "Connection handling",
+        "db": "The database layer",
+        "dialer": "Dialing connections",
+        "discover": "Remote device discovery",
+        "events": "Event generation and logging",
+        "http": "REST API",
+        "main": "Main package",
+        "model": "The root hub",
+        "protocol": "The BEP protocol",
+        "relay": "Relay connection handling",
+        "scanner": "File change detection and hashing",
+        "stats": "Persistent device and folder statistics",
+        "sync": "Mutexes",
+        "upgrade": "Binary upgrades",
+        "upnp": "UPnP discovery and port mapping",
+        "versioner": "File versioning"
+      }
+    }
diff --git a/rest/system-debug-post.rst b/rest/system-debug-post.rst
new file mode 100644
index 000000000..9e11f29c3
--- /dev/null
+++ b/rest/system-debug-post.rst
@@ -0,0 +1,13 @@
+POST /rest/system/debug
+=======================
+
+.. versionadded:: 0.12.0
+
+Enables or disables debugging for specified facilities. Give one or both of
+``enable`` and ``disable`` query parameters, with comma separated facility
+names. To disable debugging of the beacon and discovery packages, and enable it
+for config and db:
+
+.. code-block:: bash
+
+    $ curl -H X-API-Key:abc123 -X POST 'http://localhost:8385/rest/system/debug?disable=beacon,discovery&enable=config,db'
diff --git a/rest/system-error-get.rst b/rest/system-error-get.rst
index a3bcf6cbc..b3455a455 100644
--- a/rest/system-error-get.rst
+++ b/rest/system-error-get.rst
@@ -1,6 +1,8 @@
 GET /rest/system/error
 ======================
 
+.. note:: Return format changed in 0.12.0.
+
 Returns the list of recent errors.
 
 .. code-block:: json
@@ -8,8 +10,8 @@ Returns the list of recent errors.
     {
       "errors": [
         {
-          "time": "2014-09-18T12:59:26.549953186+02:00",
-          "error": "This is an error string"
+          "when": "2014-09-18T12:59:26.549953186+02:00",
+          "message": "This is an error string"
         }
       ]
     }
diff --git a/rest/system-log-get.rst b/rest/system-log-get.rst
new file mode 100644
index 000000000..9fbe0042b
--- /dev/null
+++ b/rest/system-log-get.rst
@@ -0,0 +1,17 @@
+GET /rest/system/log
+====================
+
+.. versionadded:: 0.12.0
+
+Returns the list of recent log entries.
+
+.. code-block:: json
+
+    {
+      "messages": [
+        {
+          "when": "2014-09-18T12:59:26.549953186+02:00",
+          "message": "This is a log entry"
+        }
+      ]
+    }