From 8ffc32fbb29f5369c480a261cc488737e327636c Mon Sep 17 00:00:00 2001 From: Razvan Becheriu Date: Thu, 8 Aug 2019 21:18:38 +0300 Subject: [PATCH 01/13] [#810, !471] fixed sphinx docs --- doc/sphinx/api/cache-get-by-id.json | 7 ++++--- doc/sphinx/api/cache-get.json | 6 +++--- doc/sphinx/api/cache-insert.json | 2 +- doc/sphinx/api/cache-size.json | 6 +++--- doc/sphinx/api/class-add.json | 2 +- doc/sphinx/api/class-list.json | 2 +- doc/sphinx/api/class-update.json | 2 +- doc/sphinx/api/config-get.json | 2 +- doc/sphinx/api/config-set.json | 10 +++++----- doc/sphinx/api/config-test.json | 4 ++-- doc/sphinx/api/ha-heartbeat.json | 2 +- doc/sphinx/api/ha-scopes.json | 5 +++-- doc/sphinx/api/ha-sync.json | 2 +- doc/sphinx/api/lease4-add.json | 2 +- doc/sphinx/api/lease4-get-all.json | 4 ++-- doc/sphinx/api/lease6-add.json | 2 +- doc/sphinx/api/lease6-bulk-apply.json | 4 ++-- doc/sphinx/api/network4-get.json | 4 ++-- doc/sphinx/api/network6-get.json | 4 ++-- doc/sphinx/api/remote-global-parameter4-set.json | 2 +- doc/sphinx/api/remote-network4-del.json | 2 +- 21 files changed, 39 insertions(+), 37 deletions(-) diff --git a/doc/sphinx/api/cache-get-by-id.json b/doc/sphinx/api/cache-get-by-id.json index 10a24a990a..c6cfa3658d 100644 --- a/doc/sphinx/api/cache-get-by-id.json +++ b/doc/sphinx/api/cache-get-by-id.json @@ -9,13 +9,14 @@ " \"arguments\": {", " \"hw-address\": \"01:02:03:04:05:06\"", " }" + "}" ], "hook": "host_cache", "name": "cache-get-by-id", "resp-syntax": [ "{", - " \"result\": 0", - " \"text\": \"2 entries returned.\"", + " \"result\": 0,", + " \"text\": \"2 entries returned.\",", " \"arguments\": ", "}" ], @@ -23,4 +24,4 @@ "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 3c27a11218..af8b020180 100644 --- a/doc/sphinx/api/cache-get.json +++ b/doc/sphinx/api/cache-get.json @@ -7,8 +7,8 @@ "name": "cache-get", "resp-syntax": [ "{", - " \"result\": 0", - " \"text\": \"123 entries returned.\"", + " \"result\": 0,", + " \"text\": \"123 entries returned.\",", " \"arguments\": ", "}" ], @@ -16,4 +16,4 @@ "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 64c9bc6565..c8354e910e 100644 --- a/doc/sphinx/api/cache-insert.json +++ b/doc/sphinx/api/cache-insert.json @@ -49,4 +49,4 @@ "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 b5340733d4..0b44bdeccc 100644 --- a/doc/sphinx/api/cache-size.json +++ b/doc/sphinx/api/cache-size.json @@ -7,8 +7,8 @@ "name": "cache-size", "resp-syntax": [ "{", - " \"result\": 0", - " \"text\": \"123 entries.\"", + " \"result\": 0,", + " \"text\": \"123 entries.\",", " \"arguments\": { \"size\": 123 }", "}" ], @@ -16,4 +16,4 @@ "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 611f1a490c..69a6529c73 100644 --- a/doc/sphinx/api/class-add.json +++ b/doc/sphinx/api/class-add.json @@ -34,7 +34,7 @@ "resp-syntax": [ "{", " \"result\": 0,", - " \"text\": \"Class '' added.\",", + " \"text\": \"Class '' added.\"", "}" ], "support": [ diff --git a/doc/sphinx/api/class-list.json b/doc/sphinx/api/class-list.json index 36486cbfd3..4f80828c67 100644 --- a/doc/sphinx/api/class-list.json +++ b/doc/sphinx/api/class-list.json @@ -28,7 +28,7 @@ "resp-syntax": [ "{", " \"result\": 0,", - " \"text\": \" classes found\",", + " \"text\": \"'' classes found\",", " \"arguments\": {", " \"client-classes\": [", " {", diff --git a/doc/sphinx/api/class-update.json b/doc/sphinx/api/class-update.json index dd8d67baf8..acefa18024 100644 --- a/doc/sphinx/api/class-update.json +++ b/doc/sphinx/api/class-update.json @@ -36,7 +36,7 @@ "resp-syntax": [ "{", " \"result\": 0,", - " \"text\": \"Class '' updated.\",", + " \"text\": \"Class '' updated.\"", "}" ], "support": [ diff --git a/doc/sphinx/api/config-get.json b/doc/sphinx/api/config-get.json index 2bee41388a..6c4f8231fe 100644 --- a/doc/sphinx/api/config-get.json +++ b/doc/sphinx/api/config-get.json @@ -18,7 +18,7 @@ "{", " \"result\": ,", " \"arguments\": {", - " ", + " : ", " }", "}" ], diff --git a/doc/sphinx/api/config-set.json b/doc/sphinx/api/config-set.json index 02fc74a7cf..3270c20955 100644 --- a/doc/sphinx/api/config-set.json +++ b/doc/sphinx/api/config-set.json @@ -4,13 +4,13 @@ "The config-set command instructs the server to replace its current configuration with the new configuration supplied in the command's arguments." ], "cmd-comment": [ - "where `` is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\"" + "where '' is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\"" ], "cmd-syntax": [ "{", " \"command\": \"config-set\",", " \"arguments\": {", - " \"\": {", + " \"''\": {", " }", " }", "}" @@ -18,11 +18,11 @@ "description": "See ", "name": "config-set", "resp-syntax": [ - " {\"result\": 0, \"text\": \"Configuration successful.\" }", + "{\"result\": 0, \"text\": \"Configuration successful.\" }", "", - " or", + "or", "", - " {\"result\": 1, \"text\": \"unsupported parameter: BOGUS (:16:26)\" }" + "{\"result\": 1, \"text\": \"unsupported parameter: BOGUS (:16:26)\" }" ], "support": [ "kea-dhcp4", diff --git a/doc/sphinx/api/config-test.json b/doc/sphinx/api/config-test.json index 335d06e9db..c77f1697e8 100644 --- a/doc/sphinx/api/config-test.json +++ b/doc/sphinx/api/config-test.json @@ -10,7 +10,7 @@ "{", " \"command\": \"config-test\",", " \"arguments\": {", - " \"\": {", + " \"''\": {", " }", " }", "}" @@ -20,7 +20,7 @@ "resp-syntax": [ "{ \"result\": 0, \"text\": \"Configuration seems sane...\" }", "", - " or", + "or", "", "{ \"result\": 1, \"text\": \"unsupported parameter: BOGUS (:16:26)\" }" ], diff --git a/doc/sphinx/api/ha-heartbeat.json b/doc/sphinx/api/ha-heartbeat.json index c1eed190e6..bfac1099e7 100644 --- a/doc/sphinx/api/ha-heartbeat.json +++ b/doc/sphinx/api/ha-heartbeat.json @@ -6,7 +6,7 @@ ], "cmd-syntax": [ "{", - " \"command\": \"ha-heartbeat\",", + " \"command\": \"ha-heartbeat\"", " }" ], "description": "See ", diff --git a/doc/sphinx/api/ha-scopes.json b/doc/sphinx/api/ha-scopes.json index 889961d593..c8aca2dd41 100644 --- a/doc/sphinx/api/ha-scopes.json +++ b/doc/sphinx/api/ha-scopes.json @@ -9,10 +9,11 @@ "cmd-syntax": [ "{", " \"command\": \"ha-scopes\",", - " \"service\": [ ],", + " \"service\": [ ],", " \"arguments\": {", " \"scopes\": [ \"HA_server1\", \"HA_server2\" ]", " }" + "}" ], "description": "See ", "hook": "high_availability", @@ -21,4 +22,4 @@ "kea-dhcp4", "kea-dhcp6" ] -} \ No newline at end of file +} diff --git a/doc/sphinx/api/ha-sync.json b/doc/sphinx/api/ha-sync.json index 52b34e40f5..2c1fa9dad7 100644 --- a/doc/sphinx/api/ha-sync.json +++ b/doc/sphinx/api/ha-sync.json @@ -7,7 +7,7 @@ "cmd-syntax": [ "{", " \"command\": \"ha-sync\",", - " \"service\": [ ],", " \"arguments\": {", " \"server-name\": ,", " \"max-period\": ", diff --git a/doc/sphinx/api/lease4-add.json b/doc/sphinx/api/lease4-add.json index 27e079f721..e9b701f81f 100644 --- a/doc/sphinx/api/lease4-add.json +++ b/doc/sphinx/api/lease4-add.json @@ -21,4 +21,4 @@ "support": [ "kea-dhcp4" ] -} \ No newline at end of file +} diff --git a/doc/sphinx/api/lease4-get-all.json b/doc/sphinx/api/lease4-get-all.json index 5c33b9d19d..f8eb99f999 100644 --- a/doc/sphinx/api/lease4-get-all.json +++ b/doc/sphinx/api/lease4-get-all.json @@ -8,7 +8,7 @@ ], "cmd-syntax": [ "{", - " \"command\": \"lease4-get-all\"", + " \"command\": \"lease4-get-all\",", " \"arguments\": \"subnets\"", "}" ], @@ -18,4 +18,4 @@ "support": [ "kea-dhcp4" ] -} \ No newline at end of file +} diff --git a/doc/sphinx/api/lease6-add.json b/doc/sphinx/api/lease6-add.json index a8fd13fe58..344e7841f5 100644 --- a/doc/sphinx/api/lease6-add.json +++ b/doc/sphinx/api/lease6-add.json @@ -22,7 +22,7 @@ "name": "lease6-add", "resp-syntax": [ "{ \"result\": 0, \"text\": \"Lease added.\" }", - " or ", + "or", "{ \"result\": 1, \"text\": \"missing parameter 'ip-address' (:3:19)\" }" ], "support": [ diff --git a/doc/sphinx/api/lease6-bulk-apply.json b/doc/sphinx/api/lease6-bulk-apply.json index 7f0e42dd47..77b223555a 100644 --- a/doc/sphinx/api/lease6-bulk-apply.json +++ b/doc/sphinx/api/lease6-bulk-apply.json @@ -48,7 +48,7 @@ " {", " {", " \"result\": 0,", - " \"text\": IPv6 leases bulk apply completed.", + " \"text\": \"IPv6 leases bulk apply completed.\",", " \"arguments\": {", " \"failed-deleted-leases\": [", " {", @@ -62,7 +62,7 @@ " {", " \"ip-address\": \"2001:db8:cafe::\",", " \"type\": \"IA_PD\",", - " \"result\" ,", + " \"result\": ,", " \"error-message\": ", " }", " ]", diff --git a/doc/sphinx/api/network4-get.json b/doc/sphinx/api/network4-get.json index a85de53d4d..a386286e13 100644 --- a/doc/sphinx/api/network4-get.json +++ b/doc/sphinx/api/network4-get.json @@ -40,8 +40,8 @@ " // many other subnet specific details here", " },", " {", - " \"id\": 6,", " \"subnet\": \"192.0.3.0/31\",", + " \"id\": 6,", " // many other subnet specific details here", " }", " ],", @@ -54,4 +54,4 @@ "support": [ "kea-dhcp4" ] -} \ No newline at end of file +} diff --git a/doc/sphinx/api/network6-get.json b/doc/sphinx/api/network6-get.json index 10dbfd6ebe..893bb17cb9 100644 --- a/doc/sphinx/api/network6-get.json +++ b/doc/sphinx/api/network6-get.json @@ -40,8 +40,8 @@ " // many other subnet specific details here", " },", " {", - " \"id\": 6,", " \"subnet\": \"192.0.3.0/31\",", + " \"id\": 6,", " // many other subnet specific details here", " }", " ],", @@ -54,4 +54,4 @@ "support": [ "kea-dhcp6" ] -} \ No newline at end of file +} diff --git a/doc/sphinx/api/remote-global-parameter4-set.json b/doc/sphinx/api/remote-global-parameter4-set.json index 469026f0ab..c1e5dbba29 100644 --- a/doc/sphinx/api/remote-global-parameter4-set.json +++ b/doc/sphinx/api/remote-global-parameter4-set.json @@ -8,7 +8,7 @@ ], "cmd-syntax": [ "{", - " \"command\": \"remote-global-parameter4-set\"", + " \"command\": \"remote-global-parameter4-set\",", " \"arguments\": {", " \"parameters\": {", " : ,", diff --git a/doc/sphinx/api/remote-network4-del.json b/doc/sphinx/api/remote-network4-del.json index 28be9a35db..5721162e80 100644 --- a/doc/sphinx/api/remote-network4-del.json +++ b/doc/sphinx/api/remote-network4-del.json @@ -15,7 +15,7 @@ " \"name\": ", " }", " ],", - " \"subnets-action\": \"keep\" | \"delete\",", + " \"subnets-action\": '<'keep' | 'delete'>',", " \"remote\": {", " ", " }", -- GitLab From 295f81cb1f3c22010f21daa6570acad08655eb13 Mon Sep 17 00:00:00 2001 From: Suzanne Goldlust Date: Thu, 8 Aug 2019 17:39:51 -0400 Subject: [PATCH 02/13] Fix JSON syntax errors, miscellaneous typos and grammatical errors in API docs --- doc/sphinx/api/cache-get-by-id.json | 2 +- doc/sphinx/api/cache-size.json | 2 +- doc/sphinx/api/class-add.json | 4 ++-- doc/sphinx/api/class-update.json | 8 +++---- doc/sphinx/api/ha-heartbeat.json | 6 ++--- doc/sphinx/api/lease6-bulk-apply.json | 6 ++--- .../api/remote-global-parameter4-set.json | 4 ++-- .../api/remote-global-parameter6-set.json | 6 ++--- doc/sphinx/api/remote-network4-get.json | 6 ++--- doc/sphinx/api/remote-network4-list.json | 4 ++-- doc/sphinx/api/remote-network6-get.json | 6 ++--- doc/sphinx/api/remote-network6-list.json | 4 ++-- .../api/remote-option-def4-get-all.json | 6 ++--- .../api/remote-option-def6-get-all.json | 6 ++--- doc/sphinx/api/remote-option4-global-del.json | 6 ++--- doc/sphinx/api/remote-option6-global-del.json | 6 ++--- doc/sphinx/api/remote-server4-del.json | 6 ++--- doc/sphinx/api/remote-server6-del.json | 6 ++--- doc/sphinx/api/remote-subnet4-get-by-id.json | 8 +++---- .../api/remote-subnet4-get-by-prefix.json | 6 ++--- doc/sphinx/api/remote-subnet4-list.json | 6 ++--- doc/sphinx/api/remote-subnet6-get-by-id.json | 8 +++---- .../api/remote-subnet6-get-by-prefix.json | 6 ++--- doc/sphinx/api/remote-subnet6-list.json | 6 ++--- doc/sphinx/api/reservation-get.json | 24 +++++++++---------- doc/sphinx/api/stat-lease4-get.json | 7 +++--- doc/sphinx/api/stat-lease6-get.json | 5 ++-- doc/sphinx/api/subnet4-get.json | 6 ++--- doc/sphinx/api/subnet6-get.json | 6 ++--- 29 files changed, 90 insertions(+), 92 deletions(-) diff --git a/doc/sphinx/api/cache-get-by-id.json b/doc/sphinx/api/cache-get-by-id.json index c6cfa3658d..91d5160a8a 100644 --- a/doc/sphinx/api/cache-get-by-id.json +++ b/doc/sphinx/api/cache-get-by-id.json @@ -1,7 +1,7 @@ { "avail": "1.6.0", "brief": [ - "Returns entries matching the given identifier from the host cache." + "Returns entries matching the given identifier from the host cache." ], "cmd-syntax": [ "{", diff --git a/doc/sphinx/api/cache-size.json b/doc/sphinx/api/cache-size.json index 0b44bdeccc..c7e227147c 100644 --- a/doc/sphinx/api/cache-size.json +++ b/doc/sphinx/api/cache-size.json @@ -1,7 +1,7 @@ { "avail": "1.6.0", "brief": [ - "Returns number of entries of the host cache." + "Returns the number of entries in the host cache." ], "hook": "host_cache", "name": "cache-size", diff --git a/doc/sphinx/api/class-add.json b/doc/sphinx/api/class-add.json index 69a6529c73..e4868e27ce 100644 --- a/doc/sphinx/api/class-add.json +++ b/doc/sphinx/api/class-add.json @@ -5,7 +5,7 @@ "server configuration." ], "cmd-comment": [ - "The ``next-server``, ``server-hostname`` and ``boot-file-name`` are DHCPv4 specific. Only", + "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": [ @@ -16,7 +16,7 @@ " \"name\": ,", " \"test\": ,", " \"option-data\": [