[#643,!421] Updated API doc for option definitions.

diff --git a/doc/api/remote-global-parameter4-get-all.json b/doc/api/remote-global-parameter4-get-all.json
index 0c00bdedf4919d85d825ea77405e0309a5efead4..cb9ae43c6c1688bde41c73de349d44aa1216c07c 100644 (file)
--- a/doc/api/remote-global-parameter4-get-all.json
+++ b/doc/api/remote-global-parameter4-get-all.json
@@ -13,7 +13,7 @@
         \"server-tags\": [ <single server tag as string> ]
     }
 }",
-    "cmd-comment": "The <command>server-tags</command> list is mandatory and it muct contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The special server tag \"all\" is allowed to fetch the global parameters shared by all servers.",
+    "cmd-comment": "The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The special server tag \"all\" is allowed to fetch the global parameters shared by all servers.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"DHCPv4 global parameters found.\",

diff --git a/doc/api/remote-global-parameter6-get-all.json b/doc/api/remote-global-parameter6-get-all.json
index cd27d54e1cf2b9147c5d3be7dbd13120023401b4..cacea92329ff2b6ef46cb0d116d20c37f20b7887 100644 (file)
--- a/doc/api/remote-global-parameter6-get-all.json
+++ b/doc/api/remote-global-parameter6-get-all.json
@@ -13,7 +13,7 @@
         \"server-tags\": [ <single server tag as string> ]
     }
 }",
-    "cmd-comment": "The <command>server-tags</command> list is mandatory and it muct contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The special server tag \"all\" is allowed to fetch the global parameters shared by all servers.",
+    "cmd-comment": "The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The special server tag \"all\" is allowed to fetch the global parameters shared by all servers.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"DHCPv6 global parameters found.\",

diff --git a/doc/api/remote-option-def4-del.json b/doc/api/remote-option-def4-del.json
index 0eeee2cf5db224047cbcb7237c179a0f3636714f..39051a973d01e1afa3a4ebd5f0c0812badc65a95 100644 (file)
--- a/doc/api/remote-option-def4-del.json
+++ b/doc/api/remote-option-def4-del.json
@@ -13,10 +13,11 @@
         } ],
         \"remote\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <single server tag as string> ]
     }
 }",
-    "cmd-comment": "This command includes a list with exactly one option definition specification comprising an option name and code.",
+    "cmd-comment": "This command includes a list with exactly one option definition specification comprising an option name and code. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"1 DHCPv4 option definition(s) deleted.\",

diff --git a/doc/api/remote-option-def4-get-all.json b/doc/api/remote-option-def4-get-all.json
index f921204d45596a063a51652c8e3dd7d47df092eb..646e5e1237921c0c16344c2936be32ecb309db51 100644 (file)
--- a/doc/api/remote-option-def4-get-all.json
+++ b/doc/api/remote-option-def4-get-all.json
@@ -9,10 +9,11 @@
     \"arguments\": {
         \"remote\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <single server tag as string> ]
     }
 }",
-    "cmd-comment": "This command contains no arguments besides the optional <command>remote</command>.",
+    "cmd-comment": "The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The special server tag \"all\" is allowed to fetch the option definitions shared by all servers.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"2 DHCPv4 option definition(s) found.\",
@@ -21,18 +22,18 @@
             {
                 <first option definition>,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <server tag> ]
                 }
             },
             {
                 <second option definition>,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <server tag> ]
                 }
             }
         ],
         \"count\": 2
     }
 }",
-    "resp-comment": "The returned response contains a list of maps. Each map contains an option definition specification and the metadata including database specific information associated with the returned objects."
+    "resp-comment": "The returned response contains a list of maps. Each map contains an option definition specification and the metadata including database specific information associated with the returned objects. If the server tag \"all\" is included in the command, the response contains the option definitions shared between all servers. It excludes server specific option definitions. If an explicit server tag is included in the command, the response contains all option definitions directly associated with the given server and the option definitions associated with all servers when server specific option definitions are not present."
 }

diff --git a/doc/api/remote-option-def4-get.json b/doc/api/remote-option-def4-get.json
index 0e625a1d84afaf365baf88d10c0571993e148f6a..abd6968f4679fdb32332e3eb395c786d9527b8fe 100644 (file)
--- a/doc/api/remote-option-def4-get.json
+++ b/doc/api/remote-option-def4-get.json
@@ -15,10 +15,11 @@
         ],
         \"remote\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <single server tag as string> ]
     }
 }",
-    "cmd-comment": "The desired option definition is identified by the pair of the option code/space values.",
+    "cmd-comment": "The desired option definition is identified by the pair of the option code/space values. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed to fetch the option definition instance shared by all servers.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"DHCPv4 option definition found.\",
@@ -27,12 +28,12 @@
             {
                 <option definition>,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <server tag> ]
                 }
             }
         ],
         \"count\": 1
     }
 }",
-    "resp-comment": "The metadata is included and it provides database specific information associated with the returned object."
+    "resp-comment": "The metadata is included and it provides database specific information associated with the returned object. If the \"all\" server tag was specified, the command attempts to fetch the option definition associated with all servers. If the explicit server tag is specified, the command will fetch the option definition associated with the given server. If the server specific option definition doesn't exist, it will try to fetch the option definition associated with all servers."
 }

diff --git a/doc/api/remote-option-def4-set.json b/doc/api/remote-option-def4-set.json
index 56041ef813b11a28f586a6eb23ac24d00a15364b..bd768529008480b057c9240cbb8006dab2ca8648 100644 (file)
--- a/doc/api/remote-option-def4-set.json
+++ b/doc/api/remote-option-def4-set.json
@@ -14,10 +14,11 @@
         ],
         \"remote\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <single server tag as string> ]
     }
 }",
-    "cmd-comment": "The provided list must contain exactly one option definition specification.",
+    "cmd-comment": "The provided list must contain exactly one option definition specification. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed and it associates the specified option definition with all servers.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"DHCPv4 option definition set.\"

diff --git a/doc/api/remote-option-def6-del.json b/doc/api/remote-option-def6-del.json
index daa16c3747110bfe7d1281568504b574ca65e6c0..fc0f327acfd1eeac2ebb8d4bbd7c309df6ed4b6e 100644 (file)
--- a/doc/api/remote-option-def6-del.json
+++ b/doc/api/remote-option-def6-del.json
@@ -7,18 +7,17 @@
     "cmd-syntax": "{
     \"command\": \"remote-option-def6-del\",
     \"arguments\": {
-        \"option-defs\": [
-            {
-                \"code\": <option code>,
-                \"space\": <option space
-            }
-        ],
+        \"option-defs\": [ {
+            \"code\": <option code>,
+            \"space\": <option space
+        } ],
         \"remote\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <single server tag as string> ]
     }
 }",
-    "cmd-comment": "This command includes a list with exactly one option definition specification comprising an option name and code.",
+    "cmd-comment": "This command includes a list with exactly one option definition specification comprising an option name and code. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"1 DHCPv6 option definition(s) deleted.\",

diff --git a/doc/api/remote-option-def6-get-all.json b/doc/api/remote-option-def6-get-all.json
index a212876e2d9b06dbf9e507323d944a4fd9e6315e..69fec7b9b7923edb900e66052eb3168e597d70ed 100644 (file)
--- a/doc/api/remote-option-def6-get-all.json
+++ b/doc/api/remote-option-def6-get-all.json
@@ -9,10 +9,11 @@
     \"arguments\": {
         \"remote\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <single server tag as string> ]
     }
 }",
-    "cmd-comment": "This command contains no arguments besides the optional <command>remote</command>.",
+    "cmd-comment": "The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The special server tag \"all\" is allowed to fetch the option definitions shared by all servers.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"2 DHCPv6 option definition(s) found.\",
@@ -21,18 +22,18 @@
             {
                 <first option definition>,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <server tag> ]
                 }
             },
             {
                 <second option definition>,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <server tag> ]
                 }
             }
         ],
         \"count\": 2
     }
 }",
-    "resp-comment": "The returned response contains a list of maps. Each map contains an option definition specification and the metadata including database specific information associated with the returned objects."
+    "resp-comment": "The returned response contains a list of maps. Each map contains an option definition specification and the metadata including database specific information associated with the returned objects. If the server tag \"all\" is included in the command, the response contains the option definitions shared between all servers. It excludes server specific option definitions. If an explicit server tag is included in the command, the response contains all option definitions directly associated with the given server and the option definitions associated with all servers when server specific option definitions are not present."
 }

diff --git a/doc/api/remote-option-def6-get.json b/doc/api/remote-option-def6-get.json
index f9b1500cd877f066d7336f942581f9900db09227..bfc26f365677df56c2d30a283966eb54bddb81ec 100644 (file)
--- a/doc/api/remote-option-def6-get.json
+++ b/doc/api/remote-option-def6-get.json
@@ -15,10 +15,11 @@
         ],
         \"remote\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <single server tag as string> ]
     }
 }",
-    "cmd-comment": "The desired option definition is identified by the pair of the option code/space values.",
+    "cmd-comment": "The desired option definition is identified by the pair of the option code/space values. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed to fetch the option definition instance shared by all servers.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"DHCPv6 option definition found.\",
@@ -27,12 +28,12 @@
             {
                 <option definition>,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <server tag> ]
                 }
             }
         ],
         \"count\": 1
     }
 }",
-    "resp-comment": "The metadata is included and it provides database specific information associated with the returned object."
+    "resp-comment": "The metadata is included and it provides database specific information associated with the returned object. If the \"all\" server tag was specified, the command attempts to fetch the option definition associated with all servers. If the explicit server tag is specified, the command will fetch the option definition associated with the given server. If the server specific option definition doesn't exist, it will try to fetch the option definition associated with all servers."
 }

diff --git a/doc/api/remote-option-def6-set.json b/doc/api/remote-option-def6-set.json
index 0fb748edc49cc674e1944c09ee8570c0bea52f25..18ae1c11e43a7541ee65e12fbf5348aa64c08e44 100644 (file)
--- a/doc/api/remote-option-def6-set.json
+++ b/doc/api/remote-option-def6-set.json
@@ -14,10 +14,11 @@
         ],
         \"remote\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <single server tag as string> ]
     }
 }",
-    "cmd-comment": "The provided list must contain exactly one option definition specification.",
+    "cmd-comment": "The provided list must contain exactly one option definition specification. The <command>server-tags</command> list is mandatory and it must contain exactly one server tag. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error. The server tag \"all\" is allowed and it associates the specified option definition with all servers.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"DHCPv6 option definition set.\"