[30-implement-control-socket-for-ddns-2] Updated API doc

diff --git a/doc/api/build-report.json b/doc/api/build-report.json
index 14682c083b0e0b802611bfba6edc0609e5094bff..10b62fb61064ca65c59f192ee7c28308d865672d 100644 (file)
--- a/doc/api/build-report.json
+++ b/doc/api/build-report.json
@@ -1,7 +1,7 @@
 {
     "name": "build-report",
     "brief": "Returns a list of compilation options that this particular binary was built with",
-    "support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ],
+    "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
     "avail": "1.2.0",
 
     "cmd-syntax": "{

diff --git a/doc/api/config-get.json b/doc/api/config-get.json
index 7ed254a56a9237161f61d2d9e6eda938dae069b2..70109bb16f39a6d5db5caab953b341abf0c311b8 100644 (file)
--- a/doc/api/config-get.json
+++ b/doc/api/config-get.json
@@ -3,7 +3,7 @@
     "brief": "Retrieves the current configuration used by the server. The configuration
               is roughtly equal to the configuration file, but includes additional
               changes made by other commands and due to parameters inheritance.",
-    "support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ],
+    "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
     "avail": "1.2.0",
 
     "cmd-syntax": "{

diff --git a/doc/api/config-set.json b/doc/api/config-set.json
index b8b7b009273cea664b08d3c3923038bb83fadf2f..a6042f724c79cab88cb6376859799423f261b1df 100644 (file)
--- a/doc/api/config-set.json
+++ b/doc/api/config-set.json
@@ -2,7 +2,7 @@
     "name": "config-set",
     "brief": "The config-set command instructs the server to replace its current configuration with the new configuration supplied in the command's arguments.",
     "description": "See <xref linkend=\"command-config-set\"/>",
-    "support": [ "kea-dhcp4", "kea-dhcp6" ],
+    "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
     "avail": "1.2.0",
     "cmd-syntax": "{
     \"command\": \"config-set\",

diff --git a/doc/api/config-test.json b/doc/api/config-test.json
index aa6ef357db22f9cb0e869f22c2d91c25d31e9c7d..5bd1f004e5943db3553cd6c8ca5f80a74d38e28d 100644 (file)
--- a/doc/api/config-test.json
+++ b/doc/api/config-test.json
@@ -2,7 +2,7 @@
     "name": "config-test",
     "brief": "The config-test command instructs the server to check whether the new configuration supplied in the command's arguments can be loaded.",
     "description": "See <xref linkend=\"command-config-test\"/>",
-    "support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ],
+    "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
     "avail": "1.2.0",
     "cmd-syntax": "{
     \"command\": \"config-test\",

diff --git a/doc/api/config-write.json b/doc/api/config-write.json
index bce80a9007a69bf08e30e38c38e2b60f905faeda..098f7e1c71ae052304b35a577ff55fd52dfd74f5 100644 (file)
--- a/doc/api/config-write.json
+++ b/doc/api/config-write.json
@@ -3,7 +3,7 @@
     "brief": "The config-write command instructs the Kea server to write its
               current configuration to a file on disk.",
     "description": "See <xref linkend=\"command-config-write\"/>",
-    "support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ],
+    "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
     "avail": "1.2.0",
     "cmd-syntax": "{
     \"command\": \"config-write\",

diff --git a/doc/api/list-commands.json b/doc/api/list-commands.json
index 0e3928895c15c8ebeb35e467559711542b78b426..f0318c6f9d3ba7216bf1d16daeb63d6b4fde1129 100644 (file)
--- a/doc/api/list-commands.json
+++ b/doc/api/list-commands.json
@@ -2,7 +2,7 @@
     "name": "list-commands",
     "brief": "The list-commands command retrieves a list of all commands supported by the server.",
     "description": "See <xref linkend=\"command-list-commands\"/>",
-    "support": [ "kea-dhcp4", "kea-dhcp6" , "kea-ctrl-agent" ],
+    "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
     "avail": "1.0.0",
     "cmd-syntax": "{
     \"command\": \"list-commands\",

diff --git a/doc/api/shutdown.json b/doc/api/shutdown.json
index 5d2c387ad62482821ead5dbc961709b33bd1fff1..6c9cc305b41cb0c2222d69c492d72f7140f27987 100644 (file)
--- a/doc/api/shutdown.json
+++ b/doc/api/shutdown.json
@@ -2,7 +2,7 @@
     "name": "shutdown",
     "brief": "The shutdown command instructs the server to initiate its shutdown procedure.",
     "description": "See <xref linkend=\"command-shutdown\"/>",
-    "support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ],
+    "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
     "avail": "1.0.0",
     "cmd-syntax": "{
     \"command\": \"shutdown\"

diff --git a/doc/api/version-get.json b/doc/api/version-get.json
index 7822eebabff1cca4703111239c5a0dad9541c74a..e9c192c25f53e9bc20113ef4c38f23062208eebe 100644 (file)
--- a/doc/api/version-get.json
+++ b/doc/api/version-get.json
@@ -4,7 +4,7 @@
               Kea version. The returned string is the same as if Kea would
               be run with -V command line option.",
     "description": "See <xref linkend=\"command-version-get\"/>",
-    "support": [ "kea-dhcp4", "kea-dhcp6", "kea-ctrl-agent" ],
+    "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ],
     "avail": "1.2.0",
     "cmd-syntax": "{
     \"command\": \"version-get\"

diff --git a/doc/guide/api.xml b/doc/guide/api.xml
index c8f721025aabda795694f3a5a7b968b9b809bdc8..1e39cdca3a8d24ec35325ff73d36710e119bc817 100644 (file)
--- a/doc/guide/api.xml
+++ b/doc/guide/api.xml
@@ -795,7 +795,7 @@ This command takes no parameters.</para>
   <screen>{
     "result": &lt;integer&gt;,
     "arguments": {
-        &lt;JSON configuration here, starting with Dhcp4, Dhcp6, or Control-agent object&gt;
+        &lt;JSON configuration here, starting with Dhcp4, Dhcp6, Dhcp-ddns, or Control-agent object&gt;
     }
 }</screen>
 Result is an integer representation of the status. Currently supported statuses are: