]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#2707] Doc updated
authorTomek Mrugalski <tomek@isc.org>
Wed, 21 Jun 2023 11:04:04 +0000 (13:04 +0200)
committerTomek Mrugalski <tomek@isc.org>
Thu, 22 Jun 2023 14:23:38 +0000 (16:23 +0200)
src/share/api/config-hash-get.json
src/share/api/config-set.json

index d85abd1ada066dc5e5440061952533f4d1cc2f8a..b3cf17df4f9f9a4bf54fab518fafac4a5066da4e 100644 (file)
@@ -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."
index 17305dd0f57805d124b7620dc9009290fca6ad67..31a4b7e3aeffc5fc303393aa58eaedb6ae911058 100644 (file)
     "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",