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

[#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 0c00bdedf4..cb9ae43c6c 100644
--- 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 cd27d54e1c..cacea92329 100644
--- 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 0eeee2cf5d..39051a973d 100644
--- 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 f921204d45..646e5e1237 100644
--- 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 0e625a1d84..abd6968f46 100644
--- 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 56041ef813..bd76852900 100644
--- 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 daa16c3747..fc0f327acf 100644
--- 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 a212876e2d..69fec7b9b7 100644
--- 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 f9b1500cd8..bfc26f3656 100644
--- 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 0fb748edc4..18ae1c11e4 100644
--- 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.\"