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

[#643,!421] Updated API doc for remote global option commands.

parent 757a6d21
......@@ -17,7 +17,7 @@
\"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. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error.",
"cmd-comment": "This command includes a list with exactly one option definition specification comprising an option name and code. 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.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"1 DHCPv4 option definition(s) deleted.\",
......
......@@ -17,7 +17,7 @@
\"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. Specifying an empty list, a value of <command>null</command> or multiple server tags will result in an error.",
"cmd-comment": "This command includes a list with exactly one option definition specification comprising an option name and code. 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.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"1 DHCPv6 option definition(s) deleted.\",
......
......@@ -15,10 +15,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 specification comprising an option name and code.",
"cmd-comment": "This command includes a list with exactly one option 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(s) deleted.\",
......
......@@ -9,10 +9,11 @@
\"arguments\": {
\"remote\": {
<specification of the database to connect to>
}
},
\"server-tags\": [ <single server tag as string> ]
}
}",
"cmd-comment": "This command takes no arguments besides the optional <command>remote</command> map.",
"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 options shared by all servers.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"2 DHCPv4 option(s) found.\",
......@@ -21,18 +22,18 @@
{
<first option specification>,
\"metadata\": {
\"server-tag\": <server tag>
\"server-tags\": [ <server tag> ]
}
},
{
<second option specification>,
\"metadata\": {
\"server-tag\": <server tag>
\"server-tags\": [ <server tag> ]
}
}
],
\"count\": 2
}
}",
"resp-comment": "The returned response contains a list of maps. Each map contains a global option specification and the metadata including database specific information associated with the returned object."
"resp-comment": "The returned response contains a list of maps. Each map contains a global option specification and the metadata including database specific information associated with the returned object. If the server tag \"all\" is included in the command, the response contains the global options shared between all servers. It excludes server specific global options. If an explicit server tag is included in the command, the response contains all global options directly associated with the given server and the options associated with all servers when server specific options are not present."
}
......@@ -15,9 +15,10 @@
],
\"remote\": {
<specification of the database to connect to>
}
},
\"server-tags\": [ <single server tag as string> ]
}",
"cmd-comment": "The option is identified by the pair of option code/space values.",
"cmd-comment": "The option is identified by the pair of 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 global option instance shared by all servers.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"DHCPv4 option in found.\",
......@@ -26,11 +27,11 @@
{
<option information>,
\"metadata\": {
\"server-tag\": <server tag>
\"server-tags\": [ <server tag> ]
}
}
]
}
}",
"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 global option associated with all servers. If the explicit server tag is specified, the command will fetch the global option associated with the given server. If the server specific option doesn't exist, it will try to fetch the option associated with all servers."
}
......@@ -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 cotain exactly one option specification.",
"cmd-comment": "The provided list must cotain exactly one option 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 with all servers.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"DHCPv4 option set.\",
......
......@@ -15,10 +15,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 specification comprising an option name and code.",
"cmd-comment": "This command includes a list with exactly one option 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(s) deleted.\",
......
......@@ -9,10 +9,11 @@
\"arguments\": {
\"remote\": {
<specification of the database to connect to>
}
},
\"server-tags\": [ <single server tag as string> ]
}
}",
"cmd-comment": "This command takes no arguments besides the optional <command>remote</command> map.",
"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 options shared by all servers.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"2 DHCPv6 option(s) found.\",
......@@ -21,18 +22,18 @@
{
<first option specification>,
\"metadata\": {
\"server-tag\": <server tag>
\"server-tags\": [ <server tag> ]
}
},
{
<second option specification>,
\"metadata\": {
\"server-tag\": <server tag>
\"server-tags\": [ <server tag> ]
}
}
],
\"count\": 2
}
}",
"resp-comment": "The returned response contains a list of maps. Each map contains a global option specification and the metadata including database specific information associated with the returned object."
"resp-comment": "The returned response contains a list of maps. Each map contains a global option specification and the metadata including database specific information associated with the returned object. If the server tag \"all\" is included in the command, the response contains the global options shared between all servers. It excludes server specific global options. If an explicit server tag is included in the command, the response contains all global options directly associated with the given server and the options associated with all servers when server specific options are not present."
}
{
"name": "remote-option6-global-get",
"brief": "This command is used to delete a DHCPv6 global option from the configuration database.",
"brief": "This command is used to fetch a global DHCPv6 option for the server from the specified database.",
"support": [ "kea-dhcp6" ],
"avail": "1.6.0",
"hook": "cb_cmds",
......@@ -15,22 +15,23 @@
],
\"remote\": {
<specification of the database to connect to>
}
},
\"server-tags\": [ <single server tag as string> ]
}",
"cmd-comment": "The option is identified by the pair of option code/space values.",
"cmd-comment": "The option is identified by the pair of 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 global option instance shared by all servers.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"DHCPv6 option found.\",
\"text\": \"DHCPv6 option in found.\",
\"arguments\": {
\"options\": [
{
<option information>,
\"metadata\": {
\"server-tag\": <server tag>
\"server-tags\": [ <server tag> ]
}
}
]
}
}",
"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 global option associated with all servers. If the explicit server tag is specified, the command will fetch the global option associated with the given server. If the server specific option doesn't exist, it will try to fetch the option associated with all servers."
}
......@@ -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 cotain exactly one option specification.",
"cmd-comment": "The provided list must cotain exactly one option 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 with all servers.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"DHCPv6 option 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