From 71ec70431f162ea02b45e141f76b00efa06b3ab7 Mon Sep 17 00:00:00 2001
From: Razvan Becheriu <razvan@isc.org>
Date: Fri, 9 Aug 2019 02:09:41 +0300
Subject: [PATCH] [#810, !471] fixed sphinx docs

---
 doc/sphinx/api/lease6-bulk-apply.json         | 42 +++++++++----------
 doc/sphinx/api/remote-network4-del.json       |  2 +-
 doc/sphinx/api/remote-network4-get.json       |  2 +-
 doc/sphinx/api/remote-network6-del.json       |  2 +-
 doc/sphinx/api/remote-network6-get.json       |  2 +-
 doc/sphinx/api/remote-option-def4-del.json    |  2 +-
 doc/sphinx/api/remote-option-def6-del.json    |  2 +-
 doc/sphinx/api/remote-option4-global-del.json |  2 +-
 doc/sphinx/api/remote-option4-global-get.json |  1 +
 doc/sphinx/api/remote-option6-global-del.json |  2 +-
 doc/sphinx/api/remote-option6-global-get.json |  1 +
 doc/sphinx/api/remote-server4-get.json        |  4 +-
 doc/sphinx/api/remote-server6-get.json        |  4 +-
 doc/sphinx/api/reservation-add.json           |  4 +-
 doc/sphinx/api/reservation-del.json           |  4 +-
 doc/sphinx/api/reservation-get-all.json       |  3 +-
 doc/sphinx/api/reservation-get.json           |  4 +-
 doc/sphinx/api/stat-lease6-get.json           |  2 +-
 doc/sphinx/api/subnet4-list.json              | 23 +++++-----
 doc/sphinx/api/subnet6-list.json              | 23 +++++-----
 20 files changed, 67 insertions(+), 64 deletions(-)

diff --git a/doc/sphinx/api/lease6-bulk-apply.json b/doc/sphinx/api/lease6-bulk-apply.json
index b9d5363a33..0710fcae30 100644
--- 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 5721162e80..6aee9e2dca 100644
--- 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 ece2780e08..6ae0e5bdd2 100644
--- 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 db43e100d9..402911c59f 100644
--- 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 9264e8c687..eee9257cc5 100644
--- 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 6ac87975f2..fe704c9b84 100644
--- 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 6ad13ddd0a..b4b393d9d1 100644
--- 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 eae0be3961..e88b659823 100644
--- 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 09c4ac5e75..6be271d484 100644
--- 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 ac9afa1a6c..472543ef72 100644
--- 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 48354b7eab..a0a2b9335e 100644
--- 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 d9a0bfce24..b83cdf5373 100644
--- 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 3030b0b7f4..76d58e6af9 100644
--- 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 fb3c11e791..bd7ab5ef4c 100644
--- 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 20861cbe3a..9316865d92 100644
--- 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 a45d515b40..af55a40773 100644
--- 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 800e2d2a90..78c681d34e 100644
--- 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 bb766ff370..9c2a430918 100644
--- 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 2184436e08..bd15914d9e 100644
--- 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 f32937ac85..2e5482a9d3 100644
--- 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
+}
-- 
2.47.2