[#810, !471] fixed sphinx docs

diff --git a/doc/sphinx/api/lease6-bulk-apply.json b/doc/sphinx/api/lease6-bulk-apply.json
index b9d5363a33ba827ea900067f2a041631b690a17c..0710fcae3047bc83fbd0b56accd702b048bbe500 100644 (file)
--- a/doc/sphinx/api/lease6-bulk-apply.json
+++ b/doc/sphinx/api/lease6-bulk-apply.json
@@ -45,28 +45,26 @@
         "The \"failed-deleted-leases\" holds the list of leases which failed to delete. This includes leases which were not found in the database. The \"failed-leases\" includes the list of leases which failed to create or update. For each lease for which there was an error during processing, inserting it into the database, etc., the result is set to 1. For each lease which was not deleted because the server did not find it in the database, the result of 3 is returned."
     ],
     "resp-syntax": [
-        " {",
-        "    {",
-        "        \"result\": 0,",
-        "        \"text\": \"IPv6 leases bulk apply completed.\",",
-        "        \"arguments\": {",
-        "            \"failed-deleted-leases\": [",
-        "                {",
-        "                    \"ip-address\": \"2001:db8:abcd::\",",
-        "                    \"type\": \"IA_PD\",",
-        "                    \"result\": <control result>,",
-        "                    \"error-message\": <error message>",
-        "                }",
-        "            ],",
-        "            \"failed-leases\": [",
-        "                {",
-        "                    \"ip-address\": \"2001:db8:cafe::\",",
-        "                    \"type\": \"IA_PD\",",
-        "                    \"result\": <control result>,",
-        "                    \"error-message\": <error message>",
-        "                }",
-        "            ]",
-        "        }",
+        "{",
+        "    \"result\": 0,",
+        "    \"text\": \"IPv6 leases bulk apply completed.\",",
+        "    \"arguments\": {",
+        "        \"failed-deleted-leases\": [",
+        "            {",
+        "                \"ip-address\": \"2001:db8:abcd::\",",
+        "                \"type\": \"IA_PD\",",
+        "                \"result\": <control result>,",
+        "                \"error-message\": <error message>",
+        "            }",
+        "        ],",
+        "        \"failed-leases\": [",
+        "            {",
+        "                \"ip-address\": \"2001:db8:cafe::\",",
+        "                \"type\": \"IA_PD\",",
+        "                \"result\": <control result>,",
+        "                \"error-message\": <error message>",
+        "            }",
+        "        ]",
         "    }",
         "}"
     ],

diff --git a/doc/sphinx/api/remote-network4-del.json b/doc/sphinx/api/remote-network4-del.json
index 5721162e8097fa290c9466ecabbe3dc715348729..6aee9e2dcac87f8d08d806e093859ccbfd50ff72 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>",
         "        }",

diff --git a/doc/sphinx/api/remote-network4-get.json b/doc/sphinx/api/remote-network4-get.json
index ece2780e08513ac75a9379a90993962280a24db3..6ae0e5bdd23f765109ce0c69b6953d40b3bbeabc 100644 (file)
--- a/doc/sphinx/api/remote-network4-get.json
+++ b/doc/sphinx/api/remote-network4-get.json
@@ -15,7 +15,7 @@
         "                \"name\": <shared network name>",
         "            }",
         "        ],",
-        "        \"subnets-include\": \"full\" | \"no\",",
+        "        \"subnets-include\": <'full' | 'no'>,",
         "        \"remote\": {",
         "            <specification of the database to connect to>",
         "        }",

diff --git a/doc/sphinx/api/remote-network6-del.json b/doc/sphinx/api/remote-network6-del.json
index db43e100d9f4b496577b74be50b7743dbc5b0978..402911c59fd14adb6322095e3848e3a26fd2df39 100644 (file)
--- a/doc/sphinx/api/remote-network6-del.json
+++ b/doc/sphinx/api/remote-network6-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>",
         "        }",

diff --git a/doc/sphinx/api/remote-network6-get.json b/doc/sphinx/api/remote-network6-get.json
index 9264e8c68760014bf7ea56c956ec6af9c9b37f23..eee9257cc526df36c6d9c3d5f6ea95b69b30e982 100644 (file)
--- a/doc/sphinx/api/remote-network6-get.json
+++ b/doc/sphinx/api/remote-network6-get.json
@@ -15,7 +15,7 @@
         "                \"name\": <shared network name>",
         "            }",
         "        ],",
-        "        \"subnets-include\": \"full\" | \"no\",",
+        "        \"subnets-include\": <'full' | 'no'>,",
         "        \"remote\": {",
         "            <specification of the database to connect to>",
         "        }",

diff --git a/doc/sphinx/api/remote-option-def4-del.json b/doc/sphinx/api/remote-option-def4-del.json
index 6ac87975f295fe249abe0188f6dd0a5227200a3b..fe704c9b846b45fb995fe13c9dcc9a645eb807ff 100644 (file)
--- a/doc/sphinx/api/remote-option-def4-del.json
+++ b/doc/sphinx/api/remote-option-def4-del.json
@@ -12,7 +12,7 @@
         "    \"arguments\": {",
         "        \"option-defs\": [ {",
         "            \"code\": <option code>,",
-        "            \"space\": <option space",
+        "            \"space\": <option space>",
         "        } ],",
         "        \"remote\": {",
         "            <specification of the database to connect to>",

diff --git a/doc/sphinx/api/remote-option-def6-del.json b/doc/sphinx/api/remote-option-def6-del.json
index 6ad13ddd0aca3a31ab21c67a798a584ece653473..b4b393d9d1a4facc7f6f9b5a15e42b939f9d0c77 100644 (file)
--- a/doc/sphinx/api/remote-option-def6-del.json
+++ b/doc/sphinx/api/remote-option-def6-del.json
@@ -12,7 +12,7 @@
         "    \"arguments\": {",
         "        \"option-defs\": [ {",
         "            \"code\": <option code>,",
-        "            \"space\": <option space",
+        "            \"space\": <option space>",
         "        } ],",
         "        \"remote\": {",
         "            <specification of the database to connect to>",

diff --git a/doc/sphinx/api/remote-option4-global-del.json b/doc/sphinx/api/remote-option4-global-del.json
index eae0be396129353ef4583cec5c486353f12a0740..e88b6598233936d8ce6be7db09b86222248d8f5d 100644 (file)
--- a/doc/sphinx/api/remote-option4-global-del.json
+++ b/doc/sphinx/api/remote-option4-global-del.json
@@ -13,7 +13,7 @@
         "        \"options\": [",
         "            {",
         "                \"code\": <option code>,",
-        "                \"space\": <option space>,",
+        "                \"space\": <option space>",
         "            }",
         "        ],",
         "        \"remote\": {",

diff --git a/doc/sphinx/api/remote-option4-global-get.json b/doc/sphinx/api/remote-option4-global-get.json
index 09c4ac5e752025ea1d9ce3789211f38265639ae2..6be271d484649e56e452e8c13ef0d91701d20bff 100644 (file)
--- a/doc/sphinx/api/remote-option4-global-get.json
+++ b/doc/sphinx/api/remote-option4-global-get.json
@@ -20,6 +20,7 @@
         "            <specification of the database to connect to>",
         "        },",
         "        \"server-tags\": [ <single server tag as string> ]",
+        "    }",
         "}"
     ],
     "hook": "cb_cmds",

diff --git a/doc/sphinx/api/remote-option6-global-del.json b/doc/sphinx/api/remote-option6-global-del.json
index ac9afa1a6c778e643e5ec56c19ec87e702937b82..472543ef72ef5f9c3a7c6a97cbaa7c18b9f22051 100644 (file)
--- a/doc/sphinx/api/remote-option6-global-del.json
+++ b/doc/sphinx/api/remote-option6-global-del.json
@@ -13,7 +13,7 @@
         "        \"options\": [",
         "            {",
         "                \"code\": <option code>,",
-        "                \"space\": <option space>,",
+        "                \"space\": <option space>",
         "            }",
         "        ],",
         "        \"remote\": {",

diff --git a/doc/sphinx/api/remote-option6-global-get.json b/doc/sphinx/api/remote-option6-global-get.json
index 48354b7eabdee3d99d2bbefdc30861846c9cc64b..a0a2b9335e118477999c9b08dc4cccf5362aea68 100644 (file)
--- a/doc/sphinx/api/remote-option6-global-get.json
+++ b/doc/sphinx/api/remote-option6-global-get.json
@@ -20,6 +20,7 @@
         "            <specification of the database to connect to>",
         "        },",
         "        \"server-tags\": [ <single server tag as string> ]",
+        "    }"
         "}"
     ],
     "hook": "cb_cmds",

diff --git a/doc/sphinx/api/remote-server4-get.json b/doc/sphinx/api/remote-server4-get.json
index d9a0bfce246cc7409a2e4b774b46494da50f052e..b83cdf5373175f8d67b67e1e712bc97112b7db33 100644 (file)
--- a/doc/sphinx/api/remote-server4-get.json
+++ b/doc/sphinx/api/remote-server4-get.json
@@ -29,7 +29,7 @@
     "resp-syntax": [
         "{",
         "    \"result\": 0,",
-        "    \"text\": \"DHCP server <server tag> found.\",",
+        "    \"text\": \"DHCP server 'server tag' found.\",",
         "    \"arguments\": {",
         "        \"servers\": [",
         "            {",
@@ -44,4 +44,4 @@
     "support": [
         "kea-dhcp4"
     ]
-}
\ No newline at end of file
+}

diff --git a/doc/sphinx/api/remote-server6-get.json b/doc/sphinx/api/remote-server6-get.json
index 3030b0b7f41a1a9f1ff59bb183cc3f676bdb04a3..76d58e6af9f664ffb909af5177287600e50f1b68 100644 (file)
--- a/doc/sphinx/api/remote-server6-get.json
+++ b/doc/sphinx/api/remote-server6-get.json
@@ -29,7 +29,7 @@
     "resp-syntax": [
         "{",
         "    \"result\": 0,",
-        "    \"text\": \"DHCP server <server tag> found.\",",
+        "    \"text\": \"DHCP server 'server tag' found.\",",
         "    \"arguments\": {",
         "        \"servers\": [",
         "            {",
@@ -44,4 +44,4 @@
     "support": [
         "kea-dhcp6"
     ]
-}
\ No newline at end of file
+}

diff --git a/doc/sphinx/api/reservation-add.json b/doc/sphinx/api/reservation-add.json
index fb3c11e79194631f95bd791366156d95b9ad7d32..bd7ab5ef4cf359cbeffadf876426ab0ffe286f10 100644 (file)
--- a/doc/sphinx/api/reservation-add.json
+++ b/doc/sphinx/api/reservation-add.json
@@ -17,7 +17,7 @@
         "    \"arguments\": {",
         "        \"reservation\": {",
         "            \"boot-file-name\": <string>,",
-        "            \"comment\": <string>",
+        "            \"comment\": <string>,",
         "            \"client-id\": <string>,",
         "            \"circuit-id\": <string>,",
         "            \"duid\": <string>,",
@@ -32,7 +32,7 @@
         "            \"reservation-client-classes\": [ <comma separated strings> ],",
         "            \"server-hostname\": <string>,",
         "            \"subnet-id\": <integer>,",
-        "            \"user-context\": <any valid JSON>,",
+        "            \"user-context\": <any valid JSON>",
         "        }",
         "    }",
         "}"

diff --git a/doc/sphinx/api/reservation-del.json b/doc/sphinx/api/reservation-del.json
index 20861cbe3a7ac755271fb90cbcbde468490227c7..9316865d9227fe2e65ce14bec4fc808aaf9703a3 100644 (file)
--- a/doc/sphinx/api/reservation-del.json
+++ b/doc/sphinx/api/reservation-del.json
@@ -12,7 +12,7 @@
         "    \"arguments\": {",
         "        \"subnet-id\": <integer>,",
         "        \"ip-address\": <string>,",
-        "        \"identifier-type\": <one of \"hw-address\", \"duid\", \"circuit-id\", \"client-id\" and \"flex-id\">,",
+        "        \"identifier-type\": <one of 'hw-address', 'duid', 'circuit-id', 'client-id' and 'flex-id'>,",
         "        \"identifier\": <string>",
         "    }",
         "}"
@@ -23,4 +23,4 @@
         "kea-dhcp4",
         "kea-dhcp6"
     ]
-}
\ No newline at end of file
+}

diff --git a/doc/sphinx/api/reservation-get-all.json b/doc/sphinx/api/reservation-get-all.json
index a45d515b40fa5c6036aa6096c5b4ab6410264fcf..af55a40773c01f9b9b6ee0b5f3cb158542f97003 100644 (file)
--- a/doc/sphinx/api/reservation-get-all.json
+++ b/doc/sphinx/api/reservation-get-all.json
@@ -8,6 +8,7 @@
         "    \"command\": \"reservation-get-all\",",
         "    \"arguments\": {",
         "        \"subnet-id\": <integer>",
+        "    }"
         "}"
     ],
     "hook": "host_cmds",
@@ -19,4 +20,4 @@
         "kea-dhcp4",
         "kea-dhcp6"
     ]
-}
\ No newline at end of file
+}

diff --git a/doc/sphinx/api/reservation-get.json b/doc/sphinx/api/reservation-get.json
index 800e2d2a90ed27e5aa47f60eabbf332df0dc4546..78c681d34e33e6940f67ac1c0c803c11c8ebf5e7 100644 (file)
--- a/doc/sphinx/api/reservation-get.json
+++ b/doc/sphinx/api/reservation-get.json
@@ -11,8 +11,8 @@
         "    \"command\": \"reservation-get\",",
         "    \"arguments\": {",
         "        \"subnet-id\": <integer>,",
-        "        \"identifier-type\": <one of \"hw-address\", \"duid\", \"circuit-id\", \"client-id\" and \"flex-id\">,",
-        "        \"identifier\": <string>;",
+        "        \"identifier-type\": <one of 'hw-address', 'duid', 'circuit-id', 'client-id' and 'flex-id'>,",
+        "        \"identifier\": <string>",
         "    }",
         "}"
     ],

diff --git a/doc/sphinx/api/stat-lease6-get.json b/doc/sphinx/api/stat-lease6-get.json
index bb766ff37046276f56ad120d00ac7f4b04f8fae7..9c2a4309181fe00dffd7cd144f0651f3b837bec6 100644 (file)
--- a/doc/sphinx/api/stat-lease6-get.json
+++ b/doc/sphinx/api/stat-lease6-get.json
@@ -23,7 +23,7 @@
         "        \"columns\": [ \"subnet-id\", \"total-nas\", \"assigned-nas\", \"declined-nas\", \"total-pds\", \"assigned-pds\" ],",
         "        \"rows\": [",
         "          [ 10, 4096, 2400, 3, 0, 0],",
-        "          [ 20, 0, 0, 0, 1048, 233 ]",
+        "          [ 20, 0, 0, 0, 1048, 233 ],",
         "          [ 30, 256, 60, 0, 1048, 15 ]",
         "        ],",
         "      \"timestamp\": \"2018-05-04 15:03:37.000000\"",

diff --git a/doc/sphinx/api/subnet4-list.json b/doc/sphinx/api/subnet4-list.json
index 2184436e08ad5e9b7488c035953450b20054a0cd..bd15914d9e1c6d34d17c268fb278ab53258a086a 100644 (file)
--- a/doc/sphinx/api/subnet4-list.json
+++ b/doc/sphinx/api/subnet4-list.json
@@ -19,19 +19,20 @@
         "    \"result\": 0,",
         "    \"text\": \"2 IPv4 subnets found\",",
         "    \"arguments\": {",
-        "    \"subnets\": [",
-        "        {",
-        "            \"id\": 10,",
-        "            \"subnet\": \"10.0.0.0/8\"",
-        "        },",
-        "        {",
-        "            \"id\": 100,",
-        "            \"subnet\": \"192.0.2.0/24\"",
-        "        }",
-        "    ]",
+        "        \"subnets\": [",
+        "            {",
+        "                \"id\": 10,",
+        "                \"subnet\": \"10.0.0.0/8\"",
+        "            },",
+        "            {",
+        "                \"id\": 100,",
+        "                \"subnet\": \"192.0.2.0/24\"",
+        "            }",
+        "        ]",
+        "    }",
         "}"
     ],
     "support": [
         "kea-dhcp4"
     ]
-}
\ No newline at end of file
+}

diff --git a/doc/sphinx/api/subnet6-list.json b/doc/sphinx/api/subnet6-list.json
index f32937ac855931ec0b4d52e2ec44e59d8a7e0e99..2e5482a9d3d272c16a3cfcca71977d65f0f6d51d 100644 (file)
--- a/doc/sphinx/api/subnet6-list.json
+++ b/doc/sphinx/api/subnet6-list.json
@@ -19,19 +19,20 @@
         "    \"result\": 0,",
         "    \"text\": \"2 IPv6 subnets found\",",
         "    \"arguments\": {",
-        "    \"subnets\": [",
-        "        {",
-        "            \"id\": 11,",
-        "            \"subnet\": \"2001:db8:1::/64\"",
-        "        },",
-        "        {",
-        "            \"id\": 233,",
-        "            \"subnet\": \"3000::/16\"",
-        "        }",
-        "    ]",
+        "        \"subnets\": [",
+        "            {",
+        "                \"id\": 11,",
+        "                \"subnet\": \"2001:db8:1::/64\"",
+        "            },",
+        "            {",
+        "                \"id\": 233,",
+        "                \"subnet\": \"3000::/16\"",
+        "            }",
+        "        ]",
+        "    }",
         "}"
     ],
     "support": [
         "kea-dhcp6"
     ]
-}
\ No newline at end of file
+}