[#643,!421] Updated API docs for shared networks managemen with tags.

diff --git a/doc/api/remote-network4-del.json b/doc/api/remote-network4-del.json
index d72b748e080314bf8bf3c5ed8609e3db023b82cf..8125b990e11e9baf3fc335406e534feab9497c65 100644 (file)
--- a/doc/api/remote-network4-del.json
+++ b/doc/api/remote-network4-del.json
@@ -18,7 +18,7 @@
         }
     }
 }",
-    "cmd-comment": "This command includes a list with exactly one name of the shared network to be deleted. The <command>subnets-action</command> denotes whether the subnets in this shared network should be deleted or not.",
+    "cmd-comment": "This command includes a list with exactly one name of the shared network to be deleted. The <command>subnets-action</command> denotes whether the subnets in this shared network should be deleted or not. The <command>server-tags</command> parameter must not be specified for this command.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"1 IPv4 shared network(s) deleted.\",

diff --git a/doc/api/remote-network4-get.json b/doc/api/remote-network4-get.json
index b48ee7a7861691916a5403348b45d7fd753296b5..f5e82909c037656aba494300efd131d3654c4e91 100644 (file)
--- a/doc/api/remote-network4-get.json
+++ b/doc/api/remote-network4-get.json
@@ -18,7 +18,7 @@
         }
     }
 }",
-    "cmd-comment": "This command includes a list with exactly one name of the shared network to be returned. The <command>subnets-include</command> optional parameter allows for specifying whether the subnets belonging to the shared network should also be returned.",
+    "cmd-comment": "This command includes a list with exactly one name of the shared network to be returned. The <command>subnets-include</command> optional parameter allows for specifying whether the subnets belonging to the shared network should also be returned. The <command>server-tags</command> parameter must not be specified for this command.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"IPv4 shared network found.\",

diff --git a/doc/api/remote-network4-list.json b/doc/api/remote-network4-list.json
index e69b5722b7c6246c7eaceb30f75b7e37d61f29ab..4ec463037030f75a84246ca545ac84d9292b1a4f 100644 (file)
--- a/doc/api/remote-network4-list.json
+++ b/doc/api/remote-network4-list.json
@@ -9,10 +9,11 @@
     \"arguments\": {
         \"remote\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <first server tag>, <second server tag>, ... ]
     }
 }",
-    "cmd-comment": "This command contains no arguments besides the optional <command>remote</command>.",
+    "cmd-comment": "The <command>server-tags</command> list is required for this command. This list must not be empty. It may either contain one or multiple server tags as strings or a single <command>null</command> value.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"2 IPv4 shared network(s) found.\",
@@ -21,18 +22,18 @@
             {
                 \"name\": <first shared network name>,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <first server tag>, <second server tag>, ... ]
                 }
             },
             {
                 \"name\": <second shared network name>,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <first server tag>, ... ]
                 }
             }
         ],
         \"count\": 2
     }
 }",
-    "resp-comment": "The returned response contains the list of maps. Each map contains the shared network name and the metadata which provides database specific information associated with the shared network. The returned list does not contain full definitions of the shared networks. Use <command>remote-network4-get</command> to fetch the full information about the selected shared networks."
+    "resp-comment": "The returned response contains the list of maps. Each map contains the shared network name and the metadata which provides database specific information associated with the shared network. The returned list does not contain full definitions of the shared networks. Use <command>remote-network4-get</command> to fetch the full information about the selected shared networks. If the command includes explicit server tags as strings (including the special server tag \"all\"), the list contains all shared networks which are associated with any of the specified tags. A network is returned even if it is associated with multiple servers and only one of the specified tags matches. If the command includes the <command>null</command> value in the <command>server-tags</command> list, the response contains all shared networks which are assigned to no servers (unassigned)."
 }

diff --git a/doc/api/remote-network4-set.json b/doc/api/remote-network4-set.json
index 435d3e382ae937b338c9144b3a0bd4f7e9d69bd7..f659d7c923ebdd7e4c33022694c0005d3a170cf1 100644 (file)
--- a/doc/api/remote-network4-set.json
+++ b/doc/api/remote-network4-set.json
@@ -14,10 +14,11 @@
         ],
         \"remote\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <first server tag>, <second server tag>, ... ]
     }
 }",
-    "cmd-comment": "The provided list must contain exactly one shared network specification. It must not contain subnets (\"subnet4\" parameter). The subnets are added to the shared network using <command>remote-subnet4-set</command> command.",
+    "cmd-comment": "The provided list must contain exactly one shared network specification. It must not contain subnets (\"subnet4\" parameter). The subnets are added to the shared network using <command>remote-subnet4-set</command> command. The <command>server-tags</command> list is mandatory and it must contain one or more server tags as strings to explicitly associate the shared network with one or more user defined servers. It may include the special server tag \"all\" to associate the network with all servers.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"IPv4 shared network successfully set.\"

diff --git a/doc/api/remote-network6-del.json b/doc/api/remote-network6-del.json
index 570a132097805c07447832793f4095ca655c350a..2cf042eaa6199a73e69ec6774fdd9c930ca5a09b 100644 (file)
--- a/doc/api/remote-network6-del.json
+++ b/doc/api/remote-network6-del.json
@@ -18,7 +18,7 @@
         }
     }
 }",
-    "cmd-comment": "This command includes a list with exactly one name of the shared network to be deleted. The <command>subnets-action</command> denotes whether the subnets in this shared network should be deleted or not.",
+    "cmd-comment": "This command includes a list with exactly one name of the shared network to be deleted. The <command>subnets-action</command> denotes whether the subnets in this shared network should be deleted or not. The <command>server-tags</command> parameter must not be specified for this command.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"1 IPv6 shared network(s) deleted.\",

diff --git a/doc/api/remote-network6-get.json b/doc/api/remote-network6-get.json
index 11ddab120377c7d76a8cf30ba61014a32ac1d292..f5215a4e42cfa6bfc1a063daa0fc4ccef06d4b60 100644 (file)
--- a/doc/api/remote-network6-get.json
+++ b/doc/api/remote-network6-get.json
@@ -18,7 +18,7 @@
         }
     }
 }",
-    "cmd-comment": "This command includes a list with exactly one name of the shared network to be returned. The <command>subnets-include</command> optional parameter allows for specifying whether the subnets belonging to the shared network should also be returned.",
+    "cmd-comment": "This command includes a list with exactly one name of the shared network to be returned. The <command>subnets-include</command> optional parameter allows for specifying whether the subnets belonging to the shared network should also be returned. The <command>server-tags</command> parameter must not be specified for this command.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"IPv6 shared network found.\",

diff --git a/doc/api/remote-network6-list.json b/doc/api/remote-network6-list.json
index 9fb1e0edcdce0d2d05e098328fae83431501a34b..d3e819a6072d5340e23fec7ac54fdc33f6232857 100644 (file)
--- a/doc/api/remote-network6-list.json
+++ b/doc/api/remote-network6-list.json
@@ -9,10 +9,11 @@
     \"arguments\": {
         \"remote\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <first server tag>, <second server tag>, ... ]
     }
 }",
-    "cmd-comment": "This command contains no arguments besides the optional <command>remote</command>.",
+    "cmd-comment": "The <command>server-tags</command> list is required for this command. This list must not be empty. It may either contain one or multiple server tags as strings or a single <command>null</command> value.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"2 IPv6 shared network(s) found.\",
@@ -21,18 +22,18 @@
             {
                 \"name\": <first shared network name>,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <first server tag>, <second server tag>, ... ]
                 }
             },
             {
                 \"name\": <second shared network name>,
                 \"metadata\": {
-                    \"server-tag\": <server tag>
+                    \"server-tags\": [ <first server tag>, ... ]
                 }
             }
         ],
         \"count\": 2
     }
 }",
-    "resp-comment": "The returned response contains the list of maps. Each map contains the shared network name and the metadata which provides database specific information associated with the shared network. The returned list does not contain full definitions of the shared networks. Use <command>remote-network6-get</command> to fetch the full information about the selected shared networks."
+    "resp-comment": "The returned response contains the list of maps. Each map contains the shared network name and the metadata which provides database specific information associated with the shared network. The returned list does not contain full definitions of the shared networks. Use <command>remote-network6-get</command> to fetch the full information about the selected shared networks. If the command includes explicit server tags as strings (including the special server tag \"all\"), the list contains all shared networks which are associated with any of the specified tags. A network is returned even if it is associated with multiple servers and only one of the specified tags matches. If the command includes the <command>null</command> value in the <command>server-tags</command> list, the response contains all shared networks which are assigned to no servers (unassigned)."
 }

diff --git a/doc/api/remote-network6-set.json b/doc/api/remote-network6-set.json
index 1ed48e25a2ca371b591b6258fa4a70ced9db9d68..9ea569ad431f0a3cf32e8295566885534384c17c 100644 (file)
--- a/doc/api/remote-network6-set.json
+++ b/doc/api/remote-network6-set.json
@@ -14,10 +14,11 @@
         ],
         \"remote\": {
             <specification of the database to connect to>
-        }
+        },
+        \"server-tags\": [ <first server tag>, <second server tag>, ... ]
     }
 }",
-    "cmd-comment": "The provided list must contain exactly one shared network specification. It must not contain subnets (\"subnet6\" parameter). The subnets are added to the shared network using <command>remote-subnet6-set</command> command.",
+    "cmd-comment": "The provided list must contain exactly one shared network specification. It must not contain subnets (\"subnet6\" parameter). The subnets are added to the shared network using <command>remote-subnet6-set</command> command. The <command>server-tags</command> list is mandatory and it must contain one or more server tags as strings to explicitly associate the shared network with one or more user defined servers. It may include the special server tag \"all\" to associate the network with all servers.",
     "resp-syntax": "{
     \"result\": 0,
     \"text\": \"IPv6 shared network successfully set.\"