[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 6a4513d1723be9c1bde7232e8a46fb489bee25e3..93cec1d96726bb8389affc6f684a0529d0508387 100644 (file)
--- 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 eb8418e94e0fdbba31b2078fee36f8b84bd5e4e0..9d9a8d794ab9e0402522cec1ca8606b63b3dec0d 100644 (file)
--- 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 3b62140e02f72f117bb71524c4feffa4aa51e2f8..4c71fc072bc2db50e10b11171a417d1eeed3084e 100644 (file)
--- 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 d0ddefbece9d8033631a1c112775c7632bb68880..a713180593ff2621e7e1d9eb1f6e5a369e912601 100644 (file)
--- 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 aa8c08ad5f55fdffb5085affaa232a53d8d8c7f3..b781e6c91b5b37b5ccd70f4a1d772d39178e60ab 100644 (file)
--- 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