[#643,!421] Updated API doc for remote global option commands.

diff --git a/doc/api/remote-option-def4-del.json b/doc/api/remote-option-def4-del.json
index 39051a973d01e1afa3a4ebd5f0c0812badc65a95..2c2e3d24c8b0077d9f149b8ade0b43cb0ccdcf01 100644 (file)
--- a/doc/api/remote-option-def4-del.json
+++ b/doc/api/remote-option-def4-del.json
@@ -17,7 +17,7 @@
         \"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. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error.",
+    "cmd-comment": "This command includes a list with exactly one option definition specification comprising an option name and code. 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.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"1 DHCPv4 option definition(s) deleted.\",

diff --git a/doc/api/remote-option-def6-del.json b/doc/api/remote-option-def6-del.json
index fc0f327acfd1eeac2ebb8d4bbd7c309df6ed4b6e..a5209ef8e5c0a2bb5f366dde0af7d9373538e1a6 100644 (file)
--- a/doc/api/remote-option-def6-del.json
+++ b/doc/api/remote-option-def6-del.json
@@ -17,7 +17,7 @@
         \"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. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error.",
+    "cmd-comment": "This command includes a list with exactly one option definition specification comprising an option name and code. 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.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"1 DHCPv6 option definition(s) deleted.\",

diff --git a/doc/api/remote-option4-global-del.json b/doc/api/remote-option4-global-del.json
index 9be9ad2d86c6375063d9bab1568bf9fda621a434..673532b1f549a97dc800db3a87c782f1cc2e2afe 100644 (file)
--- a/doc/api/remote-option4-global-del.json
+++ b/doc/api/remote-option4-global-del.json
@@ -15,10 +15,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 specification comprising an option name and code.",
+    "cmd-comment": "This command includes a list with exactly one option 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(s) deleted.\",

diff --git a/doc/api/remote-option4-global-get-all.json b/doc/api/remote-option4-global-get-all.json
index db75efd989c59c45da2d39b8f193e4ec3c44236c..696c36ad96f0f31e9cb4ddc6d3fd74e6e1ceeaf9 100644 (file)
--- a/doc/api/remote-option4-global-get-all.json
+++ b/doc/api/remote-option4-global-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 takes no arguments besides the optional <command>remote</command> map.",
+    "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 options shared by all servers.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"2 DHCPv4 option(s) found.\",
@@ -21,18 +22,18 @@
             {
                 <first option specification>,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <server tag> ]
                 }
             },
             {
                 <second option specification>,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <server tag> ]
                 }
             }
         ],
         \"count\": 2
     }
 }",
-    "resp-comment": "The returned response contains a list of maps. Each map contains a global option specification and the metadata including database specific information associated with the returned object."
+    "resp-comment": "The returned response contains a list of maps. Each map contains a global option specification and the metadata including database specific information associated with the returned object. If the server tag \"all\" is included in the command, the response contains the global options shared between all servers. It excludes server specific global options. If an explicit server tag is included in the command, the response contains all global options directly associated with the given server and the options associated with all servers when server specific options are not present."
 }

diff --git a/doc/api/remote-option4-global-get.json b/doc/api/remote-option4-global-get.json
index 4ceedb693b656c28967b85f4dde2e9d6d0c62b56..78c71027d4ca1edfa9f8ce1a789b523bce9100de 100644 (file)
--- a/doc/api/remote-option4-global-get.json
+++ b/doc/api/remote-option4-global-get.json
@@ -15,9 +15,10 @@
         ],
         \"remote\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <single server tag as string> ]
 }",
-    "cmd-comment": "The option is identified by the pair of option code/space values.",
+    "cmd-comment": "The option is identified by the pair of 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 global option instance shared by all servers.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"DHCPv4 option in found.\",
@@ -26,11 +27,11 @@
             {
                 <option information>,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <server tag> ]
                 }
             }
         ]
     }
 }",
-    "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 global option associated with all servers. If the explicit server tag is specified, the command will fetch the global option associated with the given server. If the server specific option doesn't exist, it will try to fetch the option associated with all servers."
 }

diff --git a/doc/api/remote-option4-global-set.json b/doc/api/remote-option4-global-set.json
index 072b0f702233a8c14be0c39886bb131a1fd6ee35..c87628891a32c8f071b623c9258343dcf113e18e 100644 (file)
--- a/doc/api/remote-option4-global-set.json
+++ b/doc/api/remote-option4-global-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 cotain exactly one option specification.",
+    "cmd-comment": "The provided list must cotain exactly one option 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 with all servers.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"DHCPv4 option set.\",

diff --git a/doc/api/remote-option6-global-del.json b/doc/api/remote-option6-global-del.json
index 7786ccca6adb2f2840dcc502f8ba6f40f715621a..fe433857c9764627f0bf16a6cd936dbb91193397 100644 (file)
--- a/doc/api/remote-option6-global-del.json
+++ b/doc/api/remote-option6-global-del.json
@@ -15,10 +15,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 specification comprising an option name and code.",
+    "cmd-comment": "This command includes a list with exactly one option 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(s) deleted.\",

diff --git a/doc/api/remote-option6-global-get-all.json b/doc/api/remote-option6-global-get-all.json
index 9abd53968ee96ac6d7fc1578404e2515085999fa..062d5e057ec56f65b7f15cdddab6f517031410db 100644 (file)
--- a/doc/api/remote-option6-global-get-all.json
+++ b/doc/api/remote-option6-global-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 takes no arguments besides the optional <command>remote</command> map.",
+    "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 options shared by all servers.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"2 DHCPv6 option(s) found.\",
@@ -21,18 +22,18 @@
             {
                 <first option specification>,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <server tag> ]
                 }
             },
             {
                 <second option specification>,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <server tag> ]
                 }
             }
         ],
         \"count\": 2
     }
 }",
-    "resp-comment": "The returned response contains a list of maps. Each map contains a global option specification and the metadata including database specific information associated with the returned object."
+    "resp-comment": "The returned response contains a list of maps. Each map contains a global option specification and the metadata including database specific information associated with the returned object. If the server tag \"all\" is included in the command, the response contains the global options shared between all servers. It excludes server specific global options. If an explicit server tag is included in the command, the response contains all global options directly associated with the given server and the options associated with all servers when server specific options are not present."
 }

diff --git a/doc/api/remote-option6-global-get.json b/doc/api/remote-option6-global-get.json
index b4ce7b625e099bd4b8cfbaf349018e290b4573aa..1835996e9799bb98764c23dc0821cdfd21a67656 100644 (file)
--- a/doc/api/remote-option6-global-get.json
+++ b/doc/api/remote-option6-global-get.json
@@ -1,6 +1,6 @@
 {
     "name": "remote-option6-global-get",
-    "brief": "This command is used to delete a DHCPv6 global option from the configuration database.",
+    "brief": "This command is used to fetch a global DHCPv6 option for the server from the specified database.",
     "support": [ "kea-dhcp6" ],
     "avail": "1.6.0",
     "hook": "cb_cmds",
@@ -15,22 +15,23 @@
         ],
         \"remote\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <single server tag as string> ]
 }",
-    "cmd-comment": "The option is identified by the pair of option code/space values.",
+    "cmd-comment": "The option is identified by the pair of 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 global option instance shared by all servers.",
     "resp-syntax": "{
     \"result\": 0,
-    \"text\": \"DHCPv6 option found.\",
+    \"text\": \"DHCPv6 option in found.\",
     \"arguments\": {
         \"options\": [
             {
                 <option information>,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <server tag> ]
                 }
             }
         ]
     }
 }",
-    "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 global option associated with all servers. If the explicit server tag is specified, the command will fetch the global option associated with the given server. If the server specific option doesn't exist, it will try to fetch the option associated with all servers."
 }

diff --git a/doc/api/remote-option6-global-set.json b/doc/api/remote-option6-global-set.json
index c13e51a454fc9e00dba0925c578ecb0fab9840cf..4275eef6ed382c5991d89d4fa4c4c2df3a7f9eee 100644 (file)
--- a/doc/api/remote-option6-global-set.json
+++ b/doc/api/remote-option6-global-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 cotain exactly one option specification.",
+    "cmd-comment": "The provided list must cotain exactly one option 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 with all servers.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"DHCPv6 option set.\",