From a5f8612bff7d10b8063f5deeb55a867bdfaabebe Mon Sep 17 00:00:00 2001 From: Francis Dupont Date: Tue, 1 Jan 2019 15:14:44 +0100 Subject: [PATCH] [30-implement-control-socket-for-ddns-2] Updated API doc --- doc/api/build-report.json | 2 +- doc/api/config-get.json | 2 +- doc/api/config-set.json | 2 +- doc/api/config-test.json | 2 +- doc/api/config-write.json | 2 +- doc/api/list-commands.json | 2 +- doc/api/shutdown.json | 2 +- doc/api/version-get.json | 2 +- doc/guide/api.xml | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/api/build-report.json b/doc/api/build-report.json index 14682c083b..10b62fb610 100644 --- 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 7ed254a56a..70109bb16f 100644 --- 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 b8b7b00927..a6042f724c 100644 --- 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 ", - "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 aa6ef357db..5bd1f004e5 100644 --- 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 ", - "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 bce80a9007..098f7e1c71 100644 --- 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 ", - "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 0e3928895c..f0318c6f9d 100644 --- 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 ", - "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 5d2c387ad6..6c9cc305b4 100644 --- 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 ", - "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 7822eebabf..e9c192c25f 100644 --- 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 ", - "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 c8f721025a..1e39cdca3a 100644 --- a/doc/guide/api.xml +++ b/doc/guide/api.xml @@ -795,7 +795,7 @@ This command takes no parameters. { "result": <integer>, "arguments": { - <JSON configuration here, starting with Dhcp4, Dhcp6, or Control-agent object> + <JSON configuration here, starting with Dhcp4, Dhcp6, Dhcp-ddns, or Control-agent object> } } Result is an integer representation of the status. Currently supported statuses are: -- GitLab