Commit aa01c037 authored by Marcin Siodelski's avatar Marcin Siodelski
Browse files

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

parent c520fba7
......@@ -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.\",
......
......@@ -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.\",
......
......@@ -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)."
}
......@@ -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.\"
......
......@@ -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.\",
......
......@@ -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.\",
......
......@@ -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)."
}
......@@ -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.\"
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment