From: Marcin Siodelski <marcin@isc.org>
Date: Mon, 15 Jul 2019 17:02:57 +0000 (+0200)
Subject: [#643,!421] Updated API doc for remote global option commands.
X-Git-Tag: Kea-1.6.0-beta2~28
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c520fba72bbebfd560221f77e73ef04814ee2769;p=thirdparty%2Fkea.git

[#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 39051a973d..2c2e3d24c8 100644
--- 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 fc0f327acf..a5209ef8e5 100644
--- 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 9be9ad2d86..673532b1f5 100644
--- 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 db75efd989..696c36ad96 100644
--- 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 4ceedb693b..78c71027d4 100644
--- 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 072b0f7022..c87628891a 100644
--- 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 7786ccca6a..fe433857c9 100644
--- 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 9abd53968e..062d5e057e 100644
--- 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 b4ce7b625e..1835996e97 100644
--- 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 c13e51a454..4275eef6ed 100644
--- 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.\",