[#810, !471] fixed sphinx docs

diff --git a/doc/sphinx/api/cache-get-by-id.json b/doc/sphinx/api/cache-get-by-id.json
index 10a24a990a71612d6e22ad9a42467a0721f73f27..c6cfa3658dabaa3a55df26c5d8d45089e7fd8428 100644 (file)
--- 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\": <list of host reservations>",
         "}"
     ],
@@ -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 3c27a1121831671c47c51b2b013c3a46d92315e0..af8b020180d09ddd6214638835151693eda67178 100644 (file)
--- 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\": <list of host reservations>",
         "}"
     ],
@@ -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 64c9bc6565d607711c337307c6237550d7e9cf8e..c8354e910e19a7885c9fe1ad27b61580ee1965ac 100644 (file)
--- 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 b5340733d47848dc64df3e676b4b88cd1e41290a..0b44bdecccbe8c9fc35f468f9402962fb58f31f0 100644 (file)
--- 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 611f1a490cb6b7fa04df5e681c7d63caa530ca44..69a6529c733a15553630efcb17cc63a131a9bf36 100644 (file)
--- a/doc/sphinx/api/class-add.json
+++ b/doc/sphinx/api/class-add.json
@@ -34,7 +34,7 @@
     "resp-syntax": [
         "{",
         "    \"result\": 0,",
-        "    \"text\": \"Class '<class-name>' added.\",",
+        "    \"text\": \"Class '<class-name>' added.\"",
         "}"
     ],
     "support": [

diff --git a/doc/sphinx/api/class-list.json b/doc/sphinx/api/class-list.json
index 36486cbfd3bf83c8e876c08e0dd1d591f470a6ac..4f80828c67403d926fc6a767ef7e81dd00272e59 100644 (file)
--- a/doc/sphinx/api/class-list.json
+++ b/doc/sphinx/api/class-list.json
@@ -28,7 +28,7 @@
     "resp-syntax": [
         "{",
         "    \"result\": 0,",
-        "    \"text\": \"<number of> classes found\",",
+        "    \"text\": \"'<number of>' classes found\",",
         "    \"arguments\": {",
         "        \"client-classes\": [",
         "            {",

diff --git a/doc/sphinx/api/class-update.json b/doc/sphinx/api/class-update.json
index dd8d67baf833722183938a42be18a5dc427a395d..acefa18024364aee0cc6faa475b5fd643d77b5e6 100644 (file)
--- a/doc/sphinx/api/class-update.json
+++ b/doc/sphinx/api/class-update.json
@@ -36,7 +36,7 @@
     "resp-syntax": [
         "{",
         "    \"result\": 0,",
-        "    \"text\": \"Class '<class-name>' updated.\",",
+        "    \"text\": \"Class '<class-name>' updated.\"",
         "}"
     ],
     "support": [

diff --git a/doc/sphinx/api/config-get.json b/doc/sphinx/api/config-get.json
index 2bee41388ad9571e10a121958dbdafb9d4eb48b2..6c4f8231fe540ff483dfdc4bd616cccc9e781102 100644 (file)
--- a/doc/sphinx/api/config-get.json
+++ b/doc/sphinx/api/config-get.json
@@ -18,7 +18,7 @@
         "{",
         "    \"result\": <integer>,",
         "    \"arguments\": {",
-        "        <JSON configuration here, starting with Dhcp4, Dhcp6, or Control-agent object>",
+        "        <Dhcp4, Dhcp6, or Control-agent object>: <JSON configuration here> ",
         "    }",
         "}"
     ],

diff --git a/doc/sphinx/api/config-set.json b/doc/sphinx/api/config-set.json
index 02fc74a7cfe498aaeccfc5bfda3a86fc5bb4aa6b..3270c20955db63cba553057af2eefb39f6369a1a 100644 (file)
--- 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 `<server>` is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\""
+        "where '<server>' is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\""
     ],
     "cmd-syntax": [
         "{",
         "    \"command\": \"config-set\",",
         "    \"arguments\":  {",
-        "        \"<server>\": {",
+        "        \"'<server>'\": {",
         "        }",
         "     }",
         "}"
@@ -18,11 +18,11 @@
     "description": "See <xref linkend=\"command-config-set\"/>",
     "name": "config-set",
     "resp-syntax": [
-        "    {\"result\": 0, \"text\": \"Configuration successful.\" }",
+        "{\"result\": 0, \"text\": \"Configuration successful.\" }",
         "",
-        "    or",
+        "or",
         "",
-        "    {\"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }"
+        "{\"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }"
     ],
     "support": [
         "kea-dhcp4",

diff --git a/doc/sphinx/api/config-test.json b/doc/sphinx/api/config-test.json
index 335d06e9dbf3854dda0dcae2728d1b69fb0f7c09..c77f1697e8063567225e2510964d8a934bca5657 100644 (file)
--- a/doc/sphinx/api/config-test.json
+++ b/doc/sphinx/api/config-test.json
@@ -10,7 +10,7 @@
         "{",
         "    \"command\": \"config-test\",",
         "    \"arguments\":  {",
-        "        \"<server>\": {",
+        "        \"'<server>'\": {",
         "        }",
         "     }",
         "}"
@@ -20,7 +20,7 @@
     "resp-syntax": [
         "{ \"result\": 0, \"text\": \"Configuration seems sane...\" }",
         "",
-        "    or",
+        "or",
         "",
         "{ \"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }"
     ],

diff --git a/doc/sphinx/api/ha-heartbeat.json b/doc/sphinx/api/ha-heartbeat.json
index c1eed190e6719d938aade43bb307959000e5d552..bfac1099e7369ddc0a18961abdeb5764f4c01677 100644 (file)
--- 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 <xref linkend=\"ha-server-states\"/>",

diff --git a/doc/sphinx/api/ha-scopes.json b/doc/sphinx/api/ha-scopes.json
index 889961d59330181ca064eea0715813ebb1cf3b26..c8aca2dd41fc5d9169d3e27d39858e98f11d0bc9 100644 (file)
--- 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, typically \"dhcp4\" or \"dhcp6\"> ],",
+        "    \"service\": [ <service, typically 'dhcp4' or 'dhcp6'> ],",
         "    \"arguments\": {",
         "        \"scopes\": [ \"HA_server1\", \"HA_server2\" ]",
         "    }"
+        "}"
     ],
     "description": "See <xref linkend=\"command-ha-scopes\"/>",
     "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 52b34e40f547e56751952a9e79eae41aac9a182a..2c1fa9dad71be59a020802a17966932f9ed53c4f 100644 (file)
--- a/doc/sphinx/api/ha-sync.json
+++ b/doc/sphinx/api/ha-sync.json
@@ -7,7 +7,7 @@
     "cmd-syntax": [
         "{",
         "    \"command\": \"ha-sync\",",
-        "    \"service\": [ <service affected: \"dhcp4\" or \"dhcp6\" ],",
+        "    \"service\": [ <service affected: 'dhcp4' or 'dhcp6'> ],",
         "    \"arguments\": {",
         "        \"server-name\": <name of the partner server>,",
         "        \"max-period\": <integer, in seconds>",

diff --git a/doc/sphinx/api/lease4-add.json b/doc/sphinx/api/lease4-add.json
index 27e079f721b8c5c3063b9501b6ac414ee8eee713..e9b701f81ff990e4cef550df6935d5367e928823 100644 (file)
--- 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 5c33b9d19de2dbf77c94614d984b64b984d0c03d..f8eb99f9998061bb3ebc1a4df3f8e33602bab9b7 100644 (file)
--- 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 a8fd13fe5863f0a36b9c02e264a46b2090d432bb..344e7841f5144c5a6dbb315a8ba881430dab8405 100644 (file)
--- 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' (<string>:3:19)\" }"
     ],
     "support": [

diff --git a/doc/sphinx/api/lease6-bulk-apply.json b/doc/sphinx/api/lease6-bulk-apply.json
index 7f0e42dd4782875c7d3c165c9dd78c4dcab895ab..77b223555a323463fbadd48a51154fc259d9bb71 100644 (file)
--- 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\" <control result>,",
+        "                    \"result\": <control result>,",
         "                    \"error-message\": <error message>",
         "                }",
         "            ]",

diff --git a/doc/sphinx/api/network4-get.json b/doc/sphinx/api/network4-get.json
index a85de53d4d1144b1a10125da94e3f66a1986c1ec..a386286e13ccd1840265a9e353ec588aa609eb13 100644 (file)
--- 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 10dbfd6ebe7d228eeedc89c41441308299b04443..893bb17cb9949d6eb4c1d06ee976724563a563be 100644 (file)
--- 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 469026f0abf5eb00d4ad5ddc5d5f3a920a1f2ccd..c1e5dbba29158f9fad26211c689fd5dc27196c7f 100644 (file)
--- 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\": {",
         "            <first parameter name>: <first parameter value>,",

diff --git a/doc/sphinx/api/remote-network4-del.json b/doc/sphinx/api/remote-network4-del.json
index 28be9a35dbc63c349e98801c97357bf338a342de..5721162e8097fa290c9466ecabbe3dc715348729 100644 (file)
--- a/doc/sphinx/api/remote-network4-del.json
+++ b/doc/sphinx/api/remote-network4-del.json
@@ -15,7 +15,7 @@
         "                \"name\": <shared network name>",
         "            }",
         "        ],",
-        "        \"subnets-action\": \"keep\" | \"delete\",",
+        "        \"subnets-action\": '<'keep' | 'delete'>',",
         "        \"remote\": {",
         "            <specification of the database to connect to>",
         "        }",