From 6471b7e1412f58f8e718451961e74c87311e259b Mon Sep 17 00:00:00 2001 From: Tomek Mrugalski Date: Tue, 6 Aug 2019 18:15:28 +0200 Subject: [PATCH] [#777,!464] .json files converted to actual proper JSON format - converted multi-line strings into list of strings --- doc/sphinx/api/build-report.json | 39 +++-- doc/sphinx/api/cache-clear.json | 15 +- doc/sphinx/api/cache-get-by-id.json | 37 +++-- doc/sphinx/api/cache-get.json | 26 ++-- doc/sphinx/api/cache-insert.json | 91 ++++++------ doc/sphinx/api/cache-load.json | 25 ++-- doc/sphinx/api/cache-remove.json | 49 ++++--- doc/sphinx/api/cache-size.json | 26 ++-- doc/sphinx/api/cache-write.json | 28 ++-- doc/sphinx/api/class-add.json | 73 ++++++---- doc/sphinx/api/class-del.json | 50 ++++--- doc/sphinx/api/class-get.json | 85 ++++++----- doc/sphinx/api/class-list.json | 77 +++++----- doc/sphinx/api/class-update.json | 77 +++++----- doc/sphinx/api/config-get.json | 47 +++--- doc/sphinx/api/config-reload.json | 25 ++-- doc/sphinx/api/config-set.json | 49 ++++--- doc/sphinx/api/config-test.json | 49 ++++--- doc/sphinx/api/config-write.json | 33 +++-- doc/sphinx/api/dhcp-disable.json | 29 ++-- doc/sphinx/api/dhcp-enable.json | 23 +-- doc/sphinx/api/ha-continue.json | 17 ++- doc/sphinx/api/ha-heartbeat.json | 29 ++-- doc/sphinx/api/ha-scopes.json | 33 +++-- doc/sphinx/api/ha-sync.json | 35 +++-- doc/sphinx/api/lease4-add.json | 34 +++-- doc/sphinx/api/lease4-del.json | 30 ++-- doc/sphinx/api/lease4-get-all.json | 28 ++-- doc/sphinx/api/lease4-get.json | 66 +++++---- doc/sphinx/api/lease4-update.json | 36 +++-- doc/sphinx/api/lease4-wipe.json | 28 ++-- doc/sphinx/api/lease6-add.json | 44 +++--- doc/sphinx/api/lease6-bulk-apply.json | 134 ++++++++++-------- doc/sphinx/api/lease6-del.json | 32 +++-- doc/sphinx/api/lease6-get-all.json | 108 +++++++------- doc/sphinx/api/lease6-get.json | 32 +++-- doc/sphinx/api/lease6-update.json | 40 +++--- doc/sphinx/api/lease6-wipe.json | 32 +++-- doc/sphinx/api/leases-reclaim.json | 29 ++-- doc/sphinx/api/libreload.json | 29 ++-- doc/sphinx/api/list-commands.json | 31 ++-- doc/sphinx/api/network4-add.json | 94 ++++++------ doc/sphinx/api/network4-del.json | 52 ++++--- doc/sphinx/api/network4-get.json | 98 +++++++------ doc/sphinx/api/network4-list.json | 44 +++--- doc/sphinx/api/network4-subnet-add.json | 40 +++--- doc/sphinx/api/network4-subnet-del.json | 40 +++--- doc/sphinx/api/network6-add.json | 98 +++++++------ doc/sphinx/api/network6-del.json | 50 ++++--- doc/sphinx/api/network6-get.json | 98 +++++++------ doc/sphinx/api/network6-list.json | 48 ++++--- doc/sphinx/api/network6-subnet-add.json | 44 +++--- doc/sphinx/api/network6-subnet-del.json | 44 +++--- .../api/remote-global-parameter4-del.json | 54 ++++--- .../api/remote-global-parameter4-get-all.json | 84 ++++++----- .../api/remote-global-parameter4-get.json | 70 +++++---- .../api/remote-global-parameter4-set.json | 68 +++++---- .../api/remote-global-parameter6-del.json | 54 ++++--- .../api/remote-global-parameter6-get-all.json | 84 ++++++----- .../api/remote-global-parameter6-get.json | 70 +++++---- .../api/remote-global-parameter6-set.json | 68 +++++---- doc/sphinx/api/remote-network4-del.json | 62 ++++---- doc/sphinx/api/remote-network4-get.json | 84 ++++++----- doc/sphinx/api/remote-network4-list.json | 84 ++++++----- doc/sphinx/api/remote-network4-set.json | 56 +++++--- doc/sphinx/api/remote-network6-del.json | 62 ++++---- doc/sphinx/api/remote-network6-get.json | 84 ++++++----- doc/sphinx/api/remote-network6-list.json | 84 ++++++----- doc/sphinx/api/remote-network6-set.json | 56 +++++--- doc/sphinx/api/remote-option-def4-del.json | 60 ++++---- .../api/remote-option-def4-get-all.json | 84 ++++++----- doc/sphinx/api/remote-option-def4-get.json | 84 ++++++----- doc/sphinx/api/remote-option-def4-set.json | 56 +++++--- doc/sphinx/api/remote-option-def6-del.json | 60 ++++---- .../api/remote-option-def6-get-all.json | 84 ++++++----- doc/sphinx/api/remote-option-def6-get.json | 84 ++++++----- doc/sphinx/api/remote-option-def6-set.json | 56 +++++--- doc/sphinx/api/remote-option4-global-del.json | 64 +++++---- .../api/remote-option4-global-get-all.json | 84 ++++++----- doc/sphinx/api/remote-option4-global-get.json | 80 ++++++----- doc/sphinx/api/remote-option4-global-set.json | 72 ++++++---- doc/sphinx/api/remote-option6-global-del.json | 64 +++++---- .../api/remote-option6-global-get-all.json | 84 ++++++----- doc/sphinx/api/remote-option6-global-get.json | 80 ++++++----- doc/sphinx/api/remote-option6-global-set.json | 72 ++++++---- doc/sphinx/api/remote-server4-del.json | 60 ++++---- doc/sphinx/api/remote-server4-get-all.json | 74 ++++++---- doc/sphinx/api/remote-server4-get.json | 76 +++++----- doc/sphinx/api/remote-server4-set.json | 72 ++++++---- doc/sphinx/api/remote-server6-del.json | 60 ++++---- doc/sphinx/api/remote-server6-get-all.json | 74 ++++++---- doc/sphinx/api/remote-server6-get.json | 76 +++++----- doc/sphinx/api/remote-server6-set.json | 72 ++++++---- doc/sphinx/api/remote-subnet4-del-by-id.json | 60 ++++---- .../api/remote-subnet4-del-by-prefix.json | 60 ++++---- doc/sphinx/api/remote-subnet4-get-by-id.json | 78 +++++----- .../api/remote-subnet4-get-by-prefix.json | 82 ++++++----- doc/sphinx/api/remote-subnet4-list.json | 92 ++++++------ doc/sphinx/api/remote-subnet4-set.json | 70 +++++---- doc/sphinx/api/remote-subnet6-del-by-id.json | 60 ++++---- .../api/remote-subnet6-del-by-prefix.json | 60 ++++---- doc/sphinx/api/remote-subnet6-get-by-id.json | 86 ++++++----- .../api/remote-subnet6-get-by-prefix.json | 82 ++++++----- doc/sphinx/api/remote-subnet6-list.json | 92 ++++++------ doc/sphinx/api/remote-subnet6-set.json | 70 +++++---- doc/sphinx/api/reservation-add.json | 94 ++++++------ doc/sphinx/api/reservation-del.json | 40 +++--- doc/sphinx/api/reservation-get-all.json | 32 +++-- doc/sphinx/api/reservation-get-page.json | 40 +++--- doc/sphinx/api/reservation-get.json | 95 +++++++------ doc/sphinx/api/server-tag-get.json | 23 +-- doc/sphinx/api/shutdown.json | 31 ++-- doc/sphinx/api/stat-lease4-get.json | 60 ++++---- doc/sphinx/api/stat-lease6-get.json | 62 ++++---- doc/sphinx/api/statistic-get-all.json | 29 ++-- doc/sphinx/api/statistic-get.json | 33 +++-- doc/sphinx/api/statistic-remove-all.json | 29 ++-- doc/sphinx/api/statistic-remove.json | 33 +++-- doc/sphinx/api/statistic-reset-all.json | 29 ++-- doc/sphinx/api/statistic-reset.json | 33 +++-- .../api/statistic-sample-age-set-all.json | 33 +++-- doc/sphinx/api/statistic-sample-age-set.json | 35 +++-- .../api/statistic-sample-count-set-all.json | 33 +++-- .../api/statistic-sample-count-set.json | 35 +++-- doc/sphinx/api/subnet4-add.json | 62 ++++---- doc/sphinx/api/subnet4-del.json | 54 ++++--- doc/sphinx/api/subnet4-get.json | 62 ++++---- doc/sphinx/api/subnet4-list.json | 54 ++++--- doc/sphinx/api/subnet4-update.json | 62 ++++---- doc/sphinx/api/subnet6-add.json | 62 ++++---- doc/sphinx/api/subnet6-del.json | 48 ++++--- doc/sphinx/api/subnet6-get.json | 62 ++++---- doc/sphinx/api/subnet6-list.json | 54 ++++--- doc/sphinx/api/subnet6-update.json | 62 ++++---- doc/sphinx/api/version-get.json | 29 ++-- doc/sphinx/index.rst | 1 + 136 files changed, 4505 insertions(+), 3204 deletions(-) diff --git a/doc/sphinx/api/build-report.json b/doc/sphinx/api/build-report.json index 10b62fb610..fb3d25f457 100644 --- a/doc/sphinx/api/build-report.json +++ b/doc/sphinx/api/build-report.json @@ -1,16 +1,27 @@ { - "name": "build-report", - "brief": "Returns a list of compilation options that this particular binary was built with", - "support": [ "kea-dhcp4", "kea-dhcp6", "kea-dhcp-ddns", "kea-ctrl-agent" ], "avail": "1.2.0", - - "cmd-syntax": "{ - \"command\": \"build-report\" -}", - - "resp-syntax": "{ - \"result\": 0, - \"text\": -}", - "resp-comment": "" -} + "brief": [ + "Returns a list of compilation options that this particular binary was built with" + ], + "cmd-syntax": [ + "{", + " \"command\": \"build-report\"", + "}" + ], + "name": "build-report", + "resp-comment": [ + "" + ], + "resp-syntax": [ + "{", + " \"result\": 0,", + " \"text\": ", + "}" + ], + "support": [ + "kea-dhcp4", + "kea-dhcp6", + "kea-dhcp-ddns", + "kea-ctrl-agent" + ] +} \ No newline at end of file diff --git a/doc/sphinx/api/cache-clear.json b/doc/sphinx/api/cache-clear.json index d1096e3e5d..085dd54d05 100644 --- a/doc/sphinx/api/cache-clear.json +++ b/doc/sphinx/api/cache-clear.json @@ -1,7 +1,12 @@ { - "name": "cache-clear", - "brief": "This command removes all cached host reservations.", - "support": [ "kea-dhcp4", "kea-dhcp6" ], + "avail": "1.4.0", + "brief": [ + "This command removes all cached host reservations." + ], "hook": "host_cache", - "avail": "1.4.0" -} + "name": "cache-clear", + "support": [ + "kea-dhcp4", + "kea-dhcp6" + ] +} \ No newline at end of file diff --git a/doc/sphinx/api/cache-get-by-id.json b/doc/sphinx/api/cache-get-by-id.json index ec7fd55826..10a24a990a 100644 --- a/doc/sphinx/api/cache-get-by-id.json +++ b/doc/sphinx/api/cache-get-by-id.json @@ -1,17 +1,26 @@ { - "name": "cache-get-by-id", - "brief": "Returns entries matching the given identifier from the host cache.", - "support": [ "kea-dhcp4", "kea-dhcp6" ], "avail": "1.6.0", + "brief": [ + "Returns entries matching the given identifier from the host cache." + ], + "cmd-syntax": [ + "{", + " \"command\": \"cache-get-by-id\",", + " \"arguments\": {", + " \"hw-address\": \"01:02:03:04:05:06\"", + " }" + ], "hook": "host_cache", - "cmd-syntax": "{ - \"command\": \"cache-get-by-id\", - \"arguments\": { - \"hw-address\": \"01:02:03:04:05:06\" - }", - "resp-syntax": "{ - \"result\": 0 - \"text\": \"2 entries returned.\" - \"arguments\": -}" -} + "name": "cache-get-by-id", + "resp-syntax": [ + "{", + " \"result\": 0", + " \"text\": \"2 entries returned.\"", + " \"arguments\": ", + "}" + ], + "support": [ + "kea-dhcp4", + "kea-dhcp6" + ] +} \ No newline at end of file diff --git a/doc/sphinx/api/cache-get.json b/doc/sphinx/api/cache-get.json index 7c72ff1b7f..3c27a11218 100644 --- a/doc/sphinx/api/cache-get.json +++ b/doc/sphinx/api/cache-get.json @@ -1,13 +1,19 @@ { - "name": "cache-get", - "brief": "Returns full content of the host cache.", - "support": [ "kea-dhcp4", "kea-dhcp6" ], "avail": "1.4.0", + "brief": [ + "Returns full content of the host cache." + ], "hook": "host_cache", - - "resp-syntax": "{ - \"result\": 0 - \"text\": \"123 entries returned.\" - \"arguments\": -}" -} + "name": "cache-get", + "resp-syntax": [ + "{", + " \"result\": 0", + " \"text\": \"123 entries returned.\"", + " \"arguments\": ", + "}" + ], + "support": [ + "kea-dhcp4", + "kea-dhcp6" + ] +} \ No newline at end of file diff --git a/doc/sphinx/api/cache-insert.json b/doc/sphinx/api/cache-insert.json index e872c9ae04..64c9bc6565 100644 --- a/doc/sphinx/api/cache-insert.json +++ b/doc/sphinx/api/cache-insert.json @@ -1,45 +1,52 @@ { - "name": "cache-insert", - "brief": "This command may be used to manually insert a host into the cache.", - "description": "See ", - "support": [ "kea-dhcp4", "kea-dhcp6" ], "avail": "1.4.0", + "brief": [ + "This command may be used to manually insert a host into the cache." + ], + "cmd-syntax": [ + "{", + " \"command\": \"cache-insert\",", + " \"arguments\": {", + " \"hw-address\": \"01:02:03:04:05:06\",", + " \"subnet-id4\": 4,", + " \"subnet-id6\": 0,", + " \"ip-address\": \"192.0.2.100\",", + " \"hostname\": \"somehost.example.org\",", + " \"client-classes4\": [ ],", + " \"client-classes6\": [ ],", + " \"option-data4\": [ ],", + " \"option-data6\": [ ],", + " \"next-server\": \"192.0.0.2\",", + " \"server-hostname\": \"server-hostname.example.org\",", + " \"boot-file-name\": \"bootfile.efi\",", + " \"host-id\": 0", + " }", + "},", + "{", + " \"command\": \"cache-insert\",", + " \"arguments\": {", + " \"hw-address\": \"01:02:03:04:05:06\",", + " \"subnet-id4\": 0,", + " \"subnet-id6\": 6,", + " \"ip-addresses\": [ \"2001:db8::cafe:babe\" ],", + " \"prefixes\": [ \"2001:db8:dead:beef::/64\" ],", + " \"hostname\": \"\",", + " \"client-classes4\": [ ],", + " \"client-classes6\": [ ],", + " \"option-data4\": [ ],", + " \"option-data6\": [ ],", + " \"next-server\": \"0.0.0.0\",", + " \"server-hostname\": \"\",", + " \"boot-file-name\": \"\",", + " \"host-id\": 0", + " }", + "}" + ], + "description": "See ", "hook": "host_cache", - "cmd-syntax": "{ - \"command\": \"cache-insert\", - \"arguments\": { - \"hw-address\": \"01:02:03:04:05:06\", - \"subnet-id4\": 4, - \"subnet-id6\": 0, - \"ip-address\": \"192.0.2.100\", - \"hostname\": \"somehost.example.org\", - \"client-classes4\": [ ], - \"client-classes6\": [ ], - \"option-data4\": [ ], - \"option-data6\": [ ], - \"next-server\": \"192.0.0.2\", - \"server-hostname\": \"server-hostname.example.org\", - \"boot-file-name\": \"bootfile.efi\", - \"host-id\": 0 - } -}, -{ - \"command\": \"cache-insert\", - \"arguments\": { - \"hw-address\": \"01:02:03:04:05:06\", - \"subnet-id4\": 0, - \"subnet-id6\": 6, - \"ip-addresses\": [ \"2001:db8::cafe:babe\" ], - \"prefixes\": [ \"2001:db8:dead:beef::/64\" ], - \"hostname\": \"\", - \"client-classes4\": [ ], - \"client-classes6\": [ ], - \"option-data4\": [ ], - \"option-data6\": [ ], - \"next-server\": \"0.0.0.0\", - \"server-hostname\": \"\", - \"boot-file-name\": \"\", - \"host-id\": 0 - } -}" -} + "name": "cache-insert", + "support": [ + "kea-dhcp4", + "kea-dhcp6" + ] +} \ No newline at end of file diff --git a/doc/sphinx/api/cache-load.json b/doc/sphinx/api/cache-load.json index 582dc11b86..823a471f4a 100644 --- a/doc/sphinx/api/cache-load.json +++ b/doc/sphinx/api/cache-load.json @@ -1,12 +1,19 @@ { - "name": "cache-load", - "brief": "This command allows load the contents of a file on disk into an in-memory cache.", - "description": "See ", - "support": [ "kea-dhcp4", "kea-dhcp6" ], "avail": "1.4.0", + "brief": [ + "This command allows load the contents of a file on disk into an in-memory cache." + ], + "cmd-syntax": [ + "{", + " \"command\": \"cache-load\",", + " \"arguments\": \"/tmp/kea-host-cache.json\"", + "}" + ], + "description": "See ", "hook": "host_cache", - "cmd-syntax": "{ - \"command\": \"cache-load\", - \"arguments\": \"/tmp/kea-host-cache.json\" -}" -} + "name": "cache-load", + "support": [ + "kea-dhcp4", + "kea-dhcp6" + ] +} \ No newline at end of file diff --git a/doc/sphinx/api/cache-remove.json b/doc/sphinx/api/cache-remove.json index 564a28ec56..c3ad0f644a 100644 --- a/doc/sphinx/api/cache-remove.json +++ b/doc/sphinx/api/cache-remove.json @@ -1,24 +1,31 @@ { - "name": "cache-remove", - "brief": "The cache-remove command works similarly to reservation-get command.", - "description": "See ", - "support": [ "kea-dhcp4", "kea-dhcp6" ], "avail": "1.4.0", + "brief": [ + "The cache-remove command works similarly to reservation-get command." + ], + "cmd-syntax": [ + "{", + " \"command\": \"cache-remove\",", + " \"arguments\": {", + " \"ip-address\": \"192.0.2.1\",", + " \"subnet-id\": 123", + " }", + "}", + "", + "Another example that removes IPv6 host identifier by DUID and specific subnet-id is:", + "{", + " \"command\": \"cache-remove\",", + " \"arguments\": {", + " \"duid\": \"00:01:ab:cd:f0:a1:c2:d3:e4\",", + " \"subnet-id\": 123", + " }", + "}" + ], + "description": "See ", "hook": "host_cache", - "cmd-syntax": "{ - \"command\": \"cache-remove\", - \"arguments\": { - \"ip-address\": \"192.0.2.1\", - \"subnet-id\": 123 - } -} - -Another example that removes IPv6 host identifier by DUID and specific subnet-id is: -{ - \"command\": \"cache-remove\", - \"arguments\": { - \"duid\": \"00:01:ab:cd:f0:a1:c2:d3:e4\", - \"subnet-id\": 123 - } -}" -} + "name": "cache-remove", + "support": [ + "kea-dhcp4", + "kea-dhcp6" + ] +} \ No newline at end of file diff --git a/doc/sphinx/api/cache-size.json b/doc/sphinx/api/cache-size.json index d30f9daa38..b5340733d4 100644 --- a/doc/sphinx/api/cache-size.json +++ b/doc/sphinx/api/cache-size.json @@ -1,13 +1,19 @@ { - "name": "cache-size", - "brief": "Returns number of entries of the host cache.", - "support": [ "kea-dhcp4", "kea-dhcp6" ], "avail": "1.6.0", + "brief": [ + "Returns number of entries of the host cache." + ], "hook": "host_cache", - - "resp-syntax": "{ - \"result\": 0 - \"text\": \"123 entries.\" - \"arguments\": { \"size\": 123 } -}" -} + "name": "cache-size", + "resp-syntax": [ + "{", + " \"result\": 0", + " \"text\": \"123 entries.\"", + " \"arguments\": { \"size\": 123 }", + "}" + ], + "support": [ + "kea-dhcp4", + "kea-dhcp6" + ] +} \ No newline at end of file diff --git a/doc/sphinx/api/cache-write.json b/doc/sphinx/api/cache-write.json index 635fe666e7..baa015f4f8 100644 --- a/doc/sphinx/api/cache-write.json +++ b/doc/sphinx/api/cache-write.json @@ -1,13 +1,21 @@ { - "name": "cache-write", - "brief": "Instructs Kea to write its host cache content to disk.", - "support": [ "kea-dhcp4", "kea-dhcp6" ], "avail": "1.4.0", + "brief": [ + "Instructs Kea to write its host cache content to disk." + ], + "cmd-comment": [ + "The command takes one mandatory argument that specifies a filename path of a file to be written." + ], + "cmd-syntax": [ + "{", + " \"command\": \"cache-write\",", + " \"arguments\": \"/path/to/the/file.json\"", + "}" + ], "hook": "host_cache", - - "cmd-syntax": "{ - \"command\": \"cache-write\", - \"arguments\": \"/path/to/the/file.json\" -}", - "cmd-comment": "The command takes one mandatory argument that specifies a filename path of a file to be written." -} + "name": "cache-write", + "support": [ + "kea-dhcp4", + "kea-dhcp6" + ] +} \ No newline at end of file diff --git a/doc/sphinx/api/class-add.json b/doc/sphinx/api/class-add.json index 69e9a47900..41fa4c30eb 100644 --- a/doc/sphinx/api/class-add.json +++ b/doc/sphinx/api/class-add.json @@ -1,33 +1,46 @@ { - "name": "class-add", - "brief": "This command is used to create and add a new class to the existing - server configuration.", - "description": "See ", - "support": [ "kea-dhcp4", "kea-dhcp6" ], "avail": "1.5.0", + "brief": [ + "This command is used to create and add a new class to the existing", + " server configuration." + ], + "cmd-comment": [ + "The next-server,", + " server-hostname and", + " boot-file-name are DHCPv4 specific. Only", + " one client class can be added with a single command. " + ], + "cmd-syntax": [ + "{", + " \"command\": \"class-add\",", + " \"arguments\": {", + " \"client-classes\": [ {", + " \"name\": ,", + " \"test\": ,", + " \"option-data\": [