From: Tomek Mrugalski <tomek@isc.org>
Date: Wed, 21 Jun 2023 11:04:04 +0000 (+0200)
Subject: [#2707] Doc updated
X-Git-Tag: Kea-2.4.0~129
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a7166db6ddd267c2f372eebca3f0eeb2fb89f1cc;p=thirdparty%2Fkea.git

[#2707] Doc updated
---

diff --git a/src/share/api/config-hash-get.json b/src/share/api/config-hash-get.json
index d85abd1ada..b3cf17df4f 100644
--- a/src/share/api/config-hash-get.json
+++ b/src/share/api/config-hash-get.json
@@ -2,7 +2,10 @@
     "access": "read",
     "avail": "2.4.0",
     "brief": [
-        "This command retrieves the hash of the current configuration used by the server. The configuration is essentially the same as the contents of the configuration file, but includes additional changes made by other commands and due to parameters' inheritance."
+        "This command retrieves the hash of the current configuration used by the server. The ",
+        "configuration is essentially the same as the contents of the configuration file, but ",
+        "includes additional changes made by other commands and due to parameters' inheritance.",
+        "Currently it is SHA256, but the algorithm may change in the future."
     ],
     "cmd-comment": [
         "This command takes no parameters."
diff --git a/src/share/api/config-set.json b/src/share/api/config-set.json
index 17305dd0f5..31a4b7e3ae 100644
--- a/src/share/api/config-set.json
+++ b/src/share/api/config-set.json
@@ -19,12 +19,23 @@
     "description": "See <xref linkend=\"command-config-set\"/>",
     "name": "config-set",
     "resp-syntax": [
-        "{ \"result\": 0, \"text\": \"Configuration successful.\" }",
+        "{",
+        "    \"arguments\": {",
+        "        \"hash\": \"8B5F5822E93178B65CE658304C37EA511BDE7D29F792AA5E88012FC741F2BE32\"",
+        "    },",
+        "    \"result\": 0,",
+        "    \"text\": \"Configuration successful.\"",
+        "}",
         "",
         "or",
         "",
         "{ \"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }"
     ],
+    "resp-comment": [
+        "Starting with Kea 2.4.0, the successful response contains an SHA256 digest of the configuration that was ",
+        "just set. It might be used to determine if a configuration has been modified or not, possibly with the ",
+        "use of config-hash-get."
+    ],
     "support": [
         "kea-dhcp4",
         "kea-dhcp6",