From: Marcin Siodelski <marcin@isc.org>
Date: Fri, 19 Jul 2019 09:39:28 +0000 (+0200)
Subject: [#643,!421] Addressed review comments.
X-Git-Tag: Kea-1.6.0-beta2~11
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=541bc2be5338e315ac20dff4fbfb892b64509d39;p=thirdparty%2Fkea.git

[#643,!421] Addressed review comments.

- Include "server-tags" instead of"server-tag" in the remote-network[46]-get
- Removed unnecessary escapes in the hooks-cb-cmds.
- Regenerated api.xml.
---

diff --git a/doc/api/remote-network4-get.json b/doc/api/remote-network4-get.json
index f5e82909c0..b8fa33b029 100644
--- a/doc/api/remote-network4-get.json
+++ b/doc/api/remote-network4-get.json
@@ -27,7 +27,7 @@
             {
                 \"name\": <shared network name>,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <first server tag>, <second server tag>, ... ]
                 },
                 <the rest of the shared network information, potentially including subnets>
             }
diff --git a/doc/api/remote-network6-get.json b/doc/api/remote-network6-get.json
index f5215a4e42..fdc75752d3 100644
--- a/doc/api/remote-network6-get.json
+++ b/doc/api/remote-network6-get.json
@@ -27,7 +27,7 @@
             {
                 \"name\": <shared network name>,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <first server tag>, <second server tag>, ... ]
                 },
                 <the rest of the shared network information, potentially including subnets>
             }
diff --git a/doc/guide/api.xml b/doc/guide/api.xml
index 6520e667d1..1a2a833b1f 100644
--- a/doc/guide/api.xml
+++ b/doc/guide/api.xml
@@ -3139,7 +3139,7 @@ This command includes a list with exactly one name of the shared network to be r
             {
                 "name": &lt;shared network name&gt;,
                 "metadata": {
-                    "server-tag": &lt;server tag&gt;
+                    "server-tags": [ &lt;first server tag&gt;, &lt;second server tag&gt;, ... ]
                 },
                 &lt;the rest of the shared network information, potentially including subnets&gt;
             }
@@ -3332,7 +3332,7 @@ This command includes a list with exactly one name of the shared network to be r
             {
                 "name": &lt;shared network name&gt;,
                 "metadata": {
-                    "server-tag": &lt;server tag&gt;
+                    "server-tags": [ &lt;first server tag&gt;, &lt;second server tag&gt;, ... ]
                 },
                 &lt;the rest of the shared network information, potentially including subnets&gt;
             }
diff --git a/doc/guide/hooks-cb-cmds.xml b/doc/guide/hooks-cb-cmds.xml
index ca3660b425..57d6fa29a5 100644
--- a/doc/guide/hooks-cb-cmds.xml
+++ b/doc/guide/hooks-cb-cmds.xml
@@ -513,12 +513,12 @@
           used by the server "server1":
 <screen>
 {
-    \"command\": \"remote-global-parameter4-get-all\",
-    \"arguments\": {
-        \"remote\": {
+    "command": "remote-global-parameter4-get-all",
+    "arguments": {
+        "remote": {
             "type": "mysql"
         },
-        \"server-tags\": [ "server1" ]
+        "server-tags": [ "server1" ]
     }
 }
 </screen>
@@ -795,7 +795,7 @@
                 }
             }
         ],
-        "count": 3
+        "count": 1
     }
 }
             </screen>
@@ -973,10 +973,10 @@
           <para>The following is the example response to this command:
           <screen>
 {
-    \"result\": 0,
-    \"text\": \"1 DHCPv6 option definition(s) found.\",
-    \"arguments\": {
-        \"option-defs\": [
+    "result": 0,
+    "text": "1 DHCPv6 option definition(s) found.",
+    "arguments": {
+        "option-defs": [
             {
                 "name": "bar",
                 "code": 1012,
@@ -990,7 +990,7 @@
                 }
             }
         ],
-        \"count\": 1
+        "count": 1
     }
 }
           </screen>
@@ -1117,12 +1117,12 @@
           the "server1":
           <screen>
 {
-    \"command\": \"remote-option6-global-get-all\",
-    \"arguments\": {
-        \"remote\": {
+    "command": "remote-option6-global-get-all",
+    "arguments": {
+        "remote": {
             "type": "mysql"
         },
-        \"server-tags\": [ "server1" ]
+        "server-tags": [ "server1" ]
     }
 }
           </screen>
@@ -1317,12 +1317,12 @@
           "server1" and "server2":
           <screen>
 {
-    \"command\": \"remote-subnet4-list\"
-    \"arguments\": {
-        \"remote\": {
+    "command": "remote-subnet4-list"
+    "arguments": {
+        "remote": {
             "type": "mysql"
         },
-        \"server-tags\": [ "server1", "server2" ]
+        "server-tags": [ "server1", "server2" ]
     }
 }
           </screen>
@@ -1335,12 +1335,12 @@
           For example:
           <screen>
 {
-    \"command\": \"remote-subnet4-list\"
-    \"arguments\": {
-        \"remote\": {
+    "command": "remote-subnet4-list"
+    "arguments": {
+        "remote": {
             "type": "mysql"
         },
-        \"server-tags\": [ null ]
+        "server-tags": [ null ]
     }
 }
           </screen>