From: Franciszek Gorski <fagorski9@gmail.com>
Date: Fri, 26 Jul 2019 11:53:28 +0000 (+0200)
Subject: [731-Kea_statistics_enhancements] add documentation
X-Git-Tag: Kea-1.6.1~10^2~9
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c4009b67580d3f2ad36762c492080278cce92283;p=thirdparty%2Fkea.git

[731-Kea_statistics_enhancements] add documentation
---

diff --git a/doc/api/statistic-set-max-sample-age-all.json b/doc/api/statistic-set-max-sample-age-all.json
index 6a4513d172..93cec1d967 100644
--- a/doc/api/statistic-set-max-sample-age-all.json
+++ b/doc/api/statistic-set-max-sample-age-all.json
@@ -10,5 +10,5 @@
         \"duration\": 1245
     }
 }",
-    "cmd-comment": "The server will respond with message about successfully setted limits for all statistics, with a result set to 0 indicating success and an empty parameters field."
+    "cmd-comment": "The server will respond with message about successfully setted limits for all statistics, with a result set to 0 indicating success and an empty parameters field. If an error is encountered, the server will return a status code of 1 (error) and the text field will contain the error description."
 }
diff --git a/doc/api/statistic-set-max-sample-age.json b/doc/api/statistic-set-max-sample-age.json
index eb8418e94e..9d9a8d794a 100644
--- a/doc/api/statistic-set-max-sample-age.json
+++ b/doc/api/statistic-set-max-sample-age.json
@@ -11,5 +11,5 @@
         \"duration\": 1245
     }
 }",
-    "cmd-comment": "The server will respond with message about successfully setted limit for the given statistic, with a result set to 0 indicating success and an empty parameters field."
+    "cmd-comment": "The server will respond with message about successfully setted limit for the given statistic, with a result set to 0 indicating success and an empty parameters field. If an error is encountered (e.g. requested statistic was not found), the server will return a status code of 1 (error) and the text field will contain the error description."
 }
diff --git a/doc/api/statistic-set-max-sample-count-all.json b/doc/api/statistic-set-max-sample-count-all.json
index 3b62140e02..4c71fc072b 100644
--- a/doc/api/statistic-set-max-sample-count-all.json
+++ b/doc/api/statistic-set-max-sample-count-all.json
@@ -10,5 +10,5 @@
         \"max-samples\": 100
     }
 }",
-    "cmd-comment": "The server will respond with message about successfully setted limits for all statistics, with a result set to 0 indicating success and an empty parameters field."
+    "cmd-comment": "The server will respond with message about successfully setted limits for all statistics, with a result set to 0 indicating success and an empty parameters field. If an error is encountered, the server will return a status code of 1 (error) and the text field will contain the error description."
 }
diff --git a/doc/api/statistic-set-max-sample-count.json b/doc/api/statistic-set-max-sample-count.json
index d0ddefbece..a713180593 100644
--- a/doc/api/statistic-set-max-sample-count.json
+++ b/doc/api/statistic-set-max-sample-count.json
@@ -11,5 +11,5 @@
         \"max-samples\": 100
     }
 }",
-    "cmd-comment": "The server will respond with message about successfully setted limit for the given statistic, with a result set to 0 indicating success and an empty parameters field."
+    "cmd-comment": "The server will respond with message about successfully setted limit for the given statistic, with a result set to 0 indicating success and an empty parameters field. If an error is encountered (e.g. requested statistic was not found), the server will return a status code of 1 (error) and the text field will contain the error description."
 }
diff --git a/doc/sphinx/api/cmds-list b/doc/sphinx/api/cmds-list
index aa8c08ad5f..b781e6c91b 100644
--- a/doc/sphinx/api/cmds-list
+++ b/doc/sphinx/api/cmds-list
@@ -37,7 +37,7 @@ lease6-get-all
 lease6-update
 lease6-wipe
 leases-reclaim
-libreloadAle trzeba
+libreload
 list-commands
 network4-add
 network4-del