From aa01c0379cf8022552f76a322bcb034ded53ea6e Mon Sep 17 00:00:00 2001 From: Marcin Siodelski Date: Mon, 15 Jul 2019 19:33:59 +0200 Subject: [PATCH] [#643,!421] Updated API docs for shared networks managemen with tags. --- doc/api/remote-network4-del.json | 2 +- doc/api/remote-network4-get.json | 2 +- doc/api/remote-network4-list.json | 11 ++++++----- doc/api/remote-network4-set.json | 5 +++-- doc/api/remote-network6-del.json | 2 +- doc/api/remote-network6-get.json | 2 +- doc/api/remote-network6-list.json | 11 ++++++----- doc/api/remote-network6-set.json | 5 +++-- 8 files changed, 22 insertions(+), 18 deletions(-) diff --git a/doc/api/remote-network4-del.json b/doc/api/remote-network4-del.json index d72b748e08..8125b990e1 100644 --- 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 subnets-action 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 subnets-action denotes whether the subnets in this shared network should be deleted or not. The server-tags 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 b48ee7a786..f5e82909c0 100644 --- 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 subnets-include 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 subnets-include optional parameter allows for specifying whether the subnets belonging to the shared network should also be returned. The server-tags 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 e69b5722b7..4ec4630370 100644 --- a/doc/api/remote-network4-list.json +++ b/doc/api/remote-network4-list.json @@ -9,10 +9,11 @@ \"arguments\": { \"remote\": { - } + }, + \"server-tags\": [ , , ... ] } }", - "cmd-comment": "This command contains no arguments besides the optional remote.", + "cmd-comment": "The server-tags 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 null value.", "resp-syntax": "{ \"result\": 0, \"text\": \"2 IPv4 shared network(s) found.\", @@ -21,18 +22,18 @@ { \"name\": , \"metadata\": { - \"server-tag\": + \"server-tags\": [ , , ... ] } }, { \"name\": , \"metadata\": { - \"server-tag\": + \"server-tags\": [ , ... ] } } ], \"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 remote-network4-get 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 remote-network4-get 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 null value in the server-tags 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 435d3e382a..f659d7c923 100644 --- a/doc/api/remote-network4-set.json +++ b/doc/api/remote-network4-set.json @@ -14,10 +14,11 @@ ], \"remote\": { - } + }, + \"server-tags\": [ , , ... ] } }", - "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 remote-subnet4-set 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 remote-subnet4-set command. The server-tags 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 570a132097..2cf042eaa6 100644 --- 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 subnets-action 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 subnets-action denotes whether the subnets in this shared network should be deleted or not. The server-tags 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 11ddab1203..f5215a4e42 100644 --- 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 subnets-include 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 subnets-include optional parameter allows for specifying whether the subnets belonging to the shared network should also be returned. The server-tags 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 9fb1e0edcd..d3e819a607 100644 --- a/doc/api/remote-network6-list.json +++ b/doc/api/remote-network6-list.json @@ -9,10 +9,11 @@ \"arguments\": { \"remote\": { - } + }, + \"server-tags\": [ , , ... ] } }", - "cmd-comment": "This command contains no arguments besides the optional remote.", + "cmd-comment": "The server-tags 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 null value.", "resp-syntax": "{ \"result\": 0, \"text\": \"2 IPv6 shared network(s) found.\", @@ -21,18 +22,18 @@ { \"name\": , \"metadata\": { - \"server-tag\": + \"server-tags\": [ , , ... ] } }, { \"name\": , \"metadata\": { - \"server-tag\": + \"server-tags\": [ , ... ] } } ], \"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 remote-network6-get 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 remote-network6-get 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 null value in the server-tags 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 1ed48e25a2..9ea569ad43 100644 --- a/doc/api/remote-network6-set.json +++ b/doc/api/remote-network6-set.json @@ -14,10 +14,11 @@ ], \"remote\": { - } + }, + \"server-tags\": [ , , ... ] } }", - "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 remote-subnet6-set 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 remote-subnet6-set command. The server-tags 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.\" -- 2.47.2