Commit 757a6d21 authored by Marcin Siodelski's avatar Marcin Siodelski
Browse files

[#643,!421] Updated API doc for option definitions.

parent 0e70fff3
......@@ -13,7 +13,7 @@
\"server-tags\": [ <single server tag as string> ]
}
}",
"cmd-comment": "The <command>server-tags</command> list is mandatory and it muct 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 parameters shared by all servers.",
"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 parameters shared by all servers.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"DHCPv4 global parameters found.\",
......
......@@ -13,7 +13,7 @@
\"server-tags\": [ <single server tag as string> ]
}
}",
"cmd-comment": "The <command>server-tags</command> list is mandatory and it muct 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 parameters shared by all servers.",
"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 parameters shared by all servers.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"DHCPv6 global parameters found.\",
......
......@@ -13,10 +13,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 definition specification comprising an option name and code.",
"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.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"1 DHCPv4 option definition(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 contains no arguments besides the optional <command>remote</command>.",
"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 option definitions shared by all servers.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"2 DHCPv4 option definition(s) found.\",
......@@ -21,18 +22,18 @@
{
<first option definition>,
\"metadata\": {
\"server-tag\": <server tag>
\"server-tags\": [ <server tag> ]
}
},
{
<second option definition>,
\"metadata\": {
\"server-tag\": <server tag>
\"server-tags\": [ <server tag> ]
}
}
],
\"count\": 2
}
}",
"resp-comment": "The returned response contains a list of maps. Each map contains an option definition specification and the metadata including database specific information associated with the returned objects."
"resp-comment": "The returned response contains a list of maps. Each map contains an option definition specification and the metadata including database specific information associated with the returned objects. If the server tag \"all\" is included in the command, the response contains the option definitions shared between all servers. It excludes server specific option definitions. If an explicit server tag is included in the command, the response contains all option definitions directly associated with the given server and the option definitions associated with all servers when server specific option definitions are not present."
}
......@@ -15,10 +15,11 @@
],
\"remote\": {
<specification of the database to connect to>
}
},
\"server-tags\": [ <single server tag as string> ]
}
}",
"cmd-comment": "The desired option definition is identified by the pair of the option code/space values.",
"cmd-comment": "The desired option definition is identified by the pair of the 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 option definition instance shared by all servers.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"DHCPv4 option definition found.\",
......@@ -27,12 +28,12 @@
{
<option definition>,
\"metadata\": {
\"server-tag\": <server tag>
\"server-tags\": [ <server tag> ]
}
}
],
\"count\": 1
}
}",
"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 option definition associated with all servers. If the explicit server tag is specified, the command will fetch the option definition associated with the given server. If the server specific option definition doesn't exist, it will try to fetch the option definition 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 contain exactly one option definition specification.",
"cmd-comment": "The provided list must contain exactly one option definition 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 definition with all servers.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"DHCPv4 option definition set.\"
......
......@@ -7,18 +7,17 @@
"cmd-syntax": "{
\"command\": \"remote-option-def6-del\",
\"arguments\": {
\"option-defs\": [
{
\"code\": <option code>,
\"space\": <option space
}
],
\"option-defs\": [ {
\"code\": <option code>,
\"space\": <option space
} ],
\"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 definition specification comprising an option name and code.",
"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.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"1 DHCPv6 option definition(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 contains no arguments besides the optional <command>remote</command>.",
"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 option definitions shared by all servers.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"2 DHCPv6 option definition(s) found.\",
......@@ -21,18 +22,18 @@
{
<first option definition>,
\"metadata\": {
\"server-tag\": <server tag>
\"server-tags\": [ <server tag> ]
}
},
{
<second option definition>,
\"metadata\": {
\"server-tag\": <server tag>
\"server-tags\": [ <server tag> ]
}
}
],
\"count\": 2
}
}",
"resp-comment": "The returned response contains a list of maps. Each map contains an option definition specification and the metadata including database specific information associated with the returned objects."
"resp-comment": "The returned response contains a list of maps. Each map contains an option definition specification and the metadata including database specific information associated with the returned objects. If the server tag \"all\" is included in the command, the response contains the option definitions shared between all servers. It excludes server specific option definitions. If an explicit server tag is included in the command, the response contains all option definitions directly associated with the given server and the option definitions associated with all servers when server specific option definitions are not present."
}
......@@ -15,10 +15,11 @@
],
\"remote\": {
<specification of the database to connect to>
}
},
\"server-tags\": [ <single server tag as string> ]
}
}",
"cmd-comment": "The desired option definition is identified by the pair of the option code/space values.",
"cmd-comment": "The desired option definition is identified by the pair of the 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 option definition instance shared by all servers.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"DHCPv6 option definition found.\",
......@@ -27,12 +28,12 @@
{
<option definition>,
\"metadata\": {
\"server-tag\": <server tag>
\"server-tags\": [ <server tag> ]
}
}
],
\"count\": 1
}
}",
"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 option definition associated with all servers. If the explicit server tag is specified, the command will fetch the option definition associated with the given server. If the server specific option definition doesn't exist, it will try to fetch the option definition 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 contain exactly one option definition specification.",
"cmd-comment": "The provided list must contain exactly one option definition 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 definition with all servers.",
"resp-syntax": "{
\"result\": 0,
\"text\": \"DHCPv6 option definition 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