diff options
123 files changed, 641 insertions, 607 deletions
diff --git a/doc/examples/kea6/all-options.json b/doc/examples/kea6/all-options.json index 4904df5853..844a921cf9 100644 --- a/doc/examples/kea6/all-options.json +++ b/doc/examples/kea6/all-options.json @@ -1791,7 +1791,6 @@ "name": "v6-dnr", "data": "1234, 23, example.some.host.org., " // please notice comma and space at the end put on purpose // this means empty last type of the record - binary type - }, // Option codes 145-65535 are unassigned. diff --git a/doc/sphinx/api2doc.py b/doc/sphinx/api2doc.py index c4af3b33c8..de56d8c33e 100755 --- a/doc/sphinx/api2doc.py +++ b/doc/sphinx/api2doc.py @@ -167,7 +167,7 @@ API Reference else: rst += ' {\n' - rst += ' "result": "<integer>",\n' + rst += ' "result": <integer>,\n' rst += ' "text": "<string>"\n' rst += ' }' rst += '\n\n' diff --git a/doc/sphinx/arm/ctrl-channel.rst b/doc/sphinx/arm/ctrl-channel.rst index 4ab515f247..5e705d4035 100644 --- a/doc/sphinx/arm/ctrl-channel.rst +++ b/doc/sphinx/arm/ctrl-channel.rst @@ -95,9 +95,10 @@ following structure: } } -The ``command`` is the name of the command to execute and is mandatory. -The ``arguments`` is a map of the parameters required to carry out the given -command. The exact content and format of the map are command-specific. +The ``command`` parameter contains the name of the command to execute and it +is mandatory. +The ``arguments`` map contains the parameters required to carry out the +given command. The exact content and format of the map are command specific. ``service`` is a list of the servers at which the control command is targeted. In the example above, the control command is targeted at the diff --git a/doc/sphinx/arm/dhcp4-srv.rst b/doc/sphinx/arm/dhcp4-srv.rst index 55989df6d1..9213236b7b 100644 --- a/doc/sphinx/arm/dhcp4-srv.rst +++ b/doc/sphinx/arm/dhcp4-srv.rst @@ -250,11 +250,10 @@ client begins the renewal and rebind processes. See section :ref:`dhcp4-t1-t2-times` for more details on generating T1 and T2. -The ``interfaces-config`` map specifies the -network interfaces on which the server should listen to -DHCP messages. The ``interfaces`` parameter specifies a list of -network interfaces on which the server should listen. Lists are opened -and closed with square brackets, with elements separated by commas. To +The ``interfaces-config`` map specifies the network interfaces on which the +server should listen to DHCP messages. The ``interfaces`` parameter specifies +a list of network interfaces on which the server should listen. Lists are +opened and closed with square brackets, with elements separated by commas. To listen on two interfaces, the ``interfaces-config`` element should look like this: @@ -2224,9 +2223,9 @@ configuration statement only defines the format of an option and does not set its value(s). The ``name``, ``code``, and ``type`` parameters are required; all others -are optional. The ``array`` default value is ``false``. The -``record-types`` and ``encapsulate`` default values are blank (``""``). -The default ``space`` is ``dhcp4``. +are optional. The ``array`` parameter default value is ``false``. The +``record-types`` and ``encapsulate`` parameters default values are blank +(``""``). The default ``space`` is ``dhcp4``. Once the new option format is defined, its value is set in the same way as for a standard option. For example, the following commands set a @@ -2275,8 +2274,8 @@ defined in the following way: ... } -The ``type`` is set to ``"record"`` to indicate that the option contains -multiple values of different types. These types are given as a +The ``type`` parameter is set to ``"record"`` to indicate that the option +contains multiple values of different types. These types are given as a comma-separated list in the ``record-types`` field and should be ones from those listed in :ref:`dhcp-types`. @@ -2297,10 +2296,10 @@ The option's values are set in an ``option-data`` statement as follows: ... } -The ``csv-format`` is set to ``true`` to indicate that the ``data`` field -comprises a comma-separated list of values. The values in ``data`` -must correspond to the types set in the ``record-types`` field of the -option definition. +The ``csv-format`` parameter is set to ``true`` to indicate that the ``data`` +field comprises a comma-separated list of values. The values in ``data`` must +correspond to the types set in the ``record-types`` field of the option +definition. When ``array`` is set to ``true`` and ``type`` is set to ``"record"``, the last field is an array, i.e. it can contain more than one value, as in: @@ -3519,7 +3518,7 @@ conflict with existing entries owned by other DHCPv4 clients. to generate DNS removal requests to D2. The DNS entries Kea creates contain a value for TTL (time to live). -The ``kea-dhcp4`` calculates that value based on +The ``kea-dhcp4`` server calculates that value based on `RFC 4702, Section 5 <https://tools.ietf.org/html/rfc4702#section-5>`__, which suggests that the TTL value be 1/3 of the lease's lifetime, with a minimum value of 10 minutes. @@ -3597,9 +3596,9 @@ following configuration is required: When Does the ``kea-dhcp4`` Server Generate a DDNS Request? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The ``kea-dhcp4`` follows the behavior prescribed for DHCP servers in `RFC -4702 <https://tools.ietf.org/html/rfc4702>`__. It is important to keep in -mind that ``kea-dhcp4`` makes the initial decision of when and what to +The ``kea-dhcp4`` server follows the behavior prescribed for DHCP servers in +`RFC 4702 <https://tools.ietf.org/html/rfc4702>`__. It is important to keep +in mind that ``kea-dhcp4`` makes the initial decision of when and what to update and forwards that information to D2 in the form of NCRs. Carrying out the actual DNS updates and dealing with such things as conflict resolution are within the purview of D2 itself @@ -3697,8 +3696,8 @@ To override client delegation, issue the following commands: ... } -The ``kea-dhcp4`` always generates DDNS update requests if the client -request only contains the Host Name option. In addition, it includes +The ``kea-dhcp4`` server always generates DDNS update requests if the +client request only contains the Host Name option. In addition, it includes an FQDN option in the response to the client with the FQDN N-S-O flags set to 0-1-0, respectively. The domain name portion of the FQDN option is the name submitted to D2 in the DDNS update request. @@ -4047,9 +4046,9 @@ for a particular subnet. Consider the following simplified server configuration: } } -The ``match-client-id`` is a boolean value which controls this behavior. -The default value of ``true`` indicates that the server will use the -client identifier for lease lookups and ``chaddr`` if the first lookup +The ``match-client-id`` parameter is a boolean value which controls this +behavior. The default value of ``true`` indicates that the server will use +the client identifier for lease lookups and ``chaddr`` if the first lookup returns no results. ``false`` means that the server will only use the ``chaddr`` to search for the client's lease. Whether the DHCID for DNS updates is generated from the client identifier or ``chaddr`` is @@ -5041,9 +5040,9 @@ For example: ] } -The ``only-if-required`` parameter is needed here to force -evaluation of the class after the lease has been allocated and thus the -reserved class has been also assigned. +The ``only-if-required`` parameter is needed here to force evaluation +of the class after the lease has been allocated and thus the reserved +class has been also assigned. .. note:: @@ -5794,8 +5793,8 @@ The ``reservations-lookup-first`` is a boolean parameter which controls whether host reservations lookup should be performed before lease lookup. This parameter has effect only when multi-threading is disabled. When multi-threading is enabled, host reservations lookup is always performed first to avoid lease -lookup resource locking. The ``reservations-lookup-first`` defaults to ``false`` -when multi-threading is disabled. +lookup resource locking. The ``reservations-lookup-first`` parameter defaults to +``false`` when multi-threading is disabled. .. _host_reservations_as_basic_access_control4: @@ -5951,6 +5950,7 @@ introduced: :: + { "Dhcp4": { "shared-networks": [ { # Name of the shared network. It may be an arbitrary string @@ -5990,6 +5990,7 @@ introduced: } ] } + } As demonstrated in the example, it is possible to mix shared and regular ("plain") subnets. Each shared network must have a unique name. This is diff --git a/doc/sphinx/arm/dhcp6-srv.rst b/doc/sphinx/arm/dhcp6-srv.rst index ab4c8d314c..06d97078d5 100644 --- a/doc/sphinx/arm/dhcp6-srv.rst +++ b/doc/sphinx/arm/dhcp6-srv.rst @@ -211,11 +211,10 @@ address to create new connections. ``renew-timer`` and ``rebind-timer`` are values (also in seconds) that define T1 and T2 timers, which govern when the client begins the renewal and rebind procedures. -The ``interfaces-config`` map specifies the -network interfaces on which the server should listen to -DHCP messages. The ``interfaces`` parameter specifies a list of -network interfaces on which the server should listen. Lists are opened -and closed with square brackets, with elements separated by commas. To +The ``interfaces-config`` map specifies the network interfaces on which the +server should listen to DHCP messages. The ``interfaces`` parameter specifies +a list of network interfaces on which the server should listen. Lists are +opened and closed with square brackets, with elements separated by commas. To listen on two interfaces, the ``interfaces-config`` element should look like this: @@ -2059,10 +2058,10 @@ option space, the parameter should be left blank. Note that the ``option-def`` configuration statement only defines the format of an option and does not set its value(s). -The ``name``, ``code``, and ``type`` parameters are required; all -others are optional. The ``array`` default value is ``false``. The -``record-types`` and ``encapsulate`` default values are blank (``""``). -The default ``space`` is ``dhcp6``. +The ``name``, ``code``, and ``type`` parameters are required; all others +are optional. The ``array`` parameter default value is ``false``. The +``record-types`` and ``encapsulate`` parameters default values are blank +(``""``). The default ``space`` is ``dhcp6``. Once the new option format is defined, its value is set in the same way as for a standard option. For example, the following commands set a @@ -2111,8 +2110,8 @@ defined in the following way: ... } -The ``type`` is set to ``"record"`` to indicate that the option contains -multiple values of different types. These types are given as a +The ``type`` parameter is set to ``"record"`` to indicate that the option +contains multiple values of different types. These types are given as a comma-separated list in the ``record-types`` field and should be ones from those listed in :ref:`dhcp-types`. @@ -2134,10 +2133,10 @@ follows: ... } -The ``csv-format`` is set to ``true`` to indicate that the ``data`` field -comprises a comma-separated list of values. The values in ``data`` -must correspond to the types set in the ``record-types`` field of the -option definition. +The ``csv-format`` parameter is set to ``true`` to indicate that the ``data`` +field comprises a comma-separated list of values. The values in ``data`` must +correspond to the types set in the ``record-types`` field of the option +definition. When ``array`` is set to ``true`` and ``type`` is set to ``"record"``, the last field is an array, i.e. it can contain more than one value, as in: @@ -3173,9 +3172,9 @@ configuration is required: When Does the ``kea-dhcp6`` Server Generate a DDNS Request? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The ``kea-dhcp6`` follows the behavior prescribed for DHCP servers in `RFC -4704 <https://tools.ietf.org/html/rfc4704>`__. It is important to keep in -mind that ``kea-dhcp6`` makes the initial decision of when and what to +The ``kea-dhcp6`` server follows the behavior prescribed for DHCP servers in +`RFC 4704 <https://tools.ietf.org/html/rfc4704>`__. It is important to keep +in mind that ``kea-dhcp6`` makes the initial decision of when and what to update and forwards that information to D2 in the form of NCRs. Carrying out the actual DNS updates and dealing with such things as conflict resolution are within the purview of D2 itself @@ -3276,8 +3275,8 @@ To override client delegation, issue the following commands: ... } -The ``kea-dhcp6`` always generates DDNS update requests if the client -request only contains the Host Name option. In addition, it includes +The ``kea-dhcp6`` server always generates DDNS update requests if the +client request only contains the Host Name option. In addition, it includes an FQDN option in the response to the client with the FQDN N-S-O flags set to 0-1-0, respectively. The domain name portion of the FQDN option is the name submitted to D2 in the DDNS update request. @@ -5183,6 +5182,7 @@ introduced: :: + { "Dhcp6": { "shared-networks": [ { # Name of the shared network. It may be an arbitrary string @@ -5227,6 +5227,7 @@ introduced: } ] } + } As demonstrated in the example, it is possible to mix shared and regular ("plain") subnets. Each shared network must have a unique name. This is diff --git a/doc/sphinx/arm/hooks-cb-cmds.rst b/doc/sphinx/arm/hooks-cb-cmds.rst index b51dd8b848..6459414c4b 100644 --- a/doc/sphinx/arm/hooks-cb-cmds.rst +++ b/doc/sphinx/arm/hooks-cb-cmds.rst @@ -9,7 +9,7 @@ be used in conjunction with the available CB hook libraries implementing the common APIs to create, read, update, and delete (CRUD) the configuration information in the respective databases. For example: the ``mysql_cb`` hook library implements this API for MySQL while the -``pgsql_cg`` hook library implements this API for PostgreSQL. +``pgsql_cb`` hook library implements this API for PostgreSQL. To manage the configuration information in a MySQL database, both the ``mysql_cb`` and ``cb_cmds`` libraries must be loaded by the server used for the configuration management. @@ -1097,8 +1097,8 @@ For example: } } -The "dhcp4" is the top-level option space where the standard DHCPv4 options -belong. The ``server-tags`` parameter is mandatory and must include a +The "dhcp4" value represents the top-level option space where the standard DHCPv4 +options belong. The ``server-tags`` parameter is mandatory and must include a single option tag or the keyword "all". If the explicit server tag is specified, this command attempts to delete a global option associated with this server. If there is no such option associated with the given server, no option @@ -1296,8 +1296,8 @@ network "fancy". } } -The "dhcp4" is the top-level option space where the standard DHCPv4 options -belong. The ``server-tags`` parameter cannot be specified for this command. +The "dhcp4" value represents the top-level option space where the standard DHCPv4 +options belong. The ``server-tags`` parameter cannot be specified for this command. .. _command-remote-option4-network-set: @@ -1382,8 +1382,8 @@ option. To delete a subnet level option, the } } -The "dhcp6" is the top-level option space where the standard DHCPv6 options -belong. The ``server-tags`` parameter cannot be specified for this command. +The "dhcp6" value represents the top-level option space where the standard DHCPv6 +options belong. The ``server-tags`` parameter cannot be specified for this command. .. _command-remote-option6-pd-pool-set: @@ -1475,8 +1475,8 @@ pool: } } -The "dhcp4" is the top-level option space where the standard DHCPv4 options -belong. The ``server-tags`` parameter cannot be specified for this command. +The "dhcp4" value represents the top-level option space where the standard DHCPv4 +options belong. The ``server-tags`` parameter cannot be specified for this command. .. _command-remote-option4-pool-set: @@ -1564,8 +1564,8 @@ having an identifier of 123. } } -The "dhcp4" is the top-level option space where the standard DHCPv4 options -belong. The ``server-tags`` parameter cannot be specified for this command. +The "dhcp4" value represents the top-level option space where the standard DHCPv4 +options belong. The ``server-tags`` parameter cannot be specified for this command. .. _command-remote-option4-subnet-set: diff --git a/doc/sphinx/arm/hooks-host-cmds.rst b/doc/sphinx/arm/hooks-host-cmds.rst index d6573f57cd..0ec1013cb9 100644 --- a/doc/sphinx/arm/hooks-host-cmds.rst +++ b/doc/sphinx/arm/hooks-host-cmds.rst @@ -269,7 +269,7 @@ follows: } } -The ``reservation-get`` typically returns the result 0 when a query was +``reservation-get`` typically returns the result 0 when a query was conducted properly. In particular, 0 is returned when the host was not found. If the query was successful, the host parameters are returned. An example of a query that did not find the host looks as @@ -685,7 +685,7 @@ follows: } } -The ``reservation-del`` returns a result of 0 when the host deletion was +``reservation-del`` returns a result of 0 when the host deletion was successful, or 1 if it failed. Descriptive text is provided in the event of an error. Here are some examples of possible results: diff --git a/doc/sphinx/arm/hooks-lease-cmds.rst b/doc/sphinx/arm/hooks-lease-cmds.rst index ae0ae0c81f..63d42b6195 100644 --- a/doc/sphinx/arm/hooks-lease-cmds.rst +++ b/doc/sphinx/arm/hooks-lease-cmds.rst @@ -166,8 +166,8 @@ subnet. For example: } } -The ``lease6-add`` can also be used to add leases for IPv6 prefixes. In this -case there are three additional parameters that must be specified: +The ``lease6-add`` command can also be used to add leases for IPv6 prefixes. +In this case there are three additional parameters that must be specified: ``subnet-id``, ``type`` (set to "IA_PD"), and prefix length. The actual prefix is set using the ``ip-address`` field. Note that Kea cannot guess ``subnet-id`` values for prefixes; they must be specified explicitly. For @@ -840,7 +840,7 @@ This parameter defaults to ``false``. An example of its use is shown below: } -The ``lease4-del`` and ``lease6-del`` return a result that indicates the outcome +``lease4-del`` and ``lease6-del`` return a result that indicates the outcome of the operation. It has one of the following values: 0 (success), 1 (error), or 3 (empty). The empty result means that a query has been completed properly, but the object (a lease, in this case) has not been found. @@ -1000,11 +1000,10 @@ An example of the ``lease6-resend-ddns`` query is: } } -The ``lease4-resend-ddns`` and ``lease6-resend-ddns`` return an indication of the -result of the operation. -it has one of the following values: 0 (success), 1 (error), or 3 (empty). An empty -result means that a query has been completed properly, but the object (a lease in -this case) has not been found. +``lease4-resend-ddns`` and ``lease6-resend-ddns`` return an indication of the +result of the operation. It has one of the following values: 0 (success), 1 (error), +or 3 (empty). An empty result means that a query has been completed properly, but the +object (a lease in this case) has not been found. A successful result does not mean that DNS has been successfully updated; it indicates that a request to update DNS has been successfully created and diff --git a/src/lib/dhcp/duid.cc b/src/lib/dhcp/duid.cc index 0b18f23f1e..1986880380 100644 --- a/src/lib/dhcp/duid.cc +++ b/src/lib/dhcp/duid.cc @@ -22,6 +22,9 @@ namespace dhcp { IdentifierBaseType::~IdentifierBaseType() { } +constexpr size_t DUID::MIN_DUID_LEN; +constexpr size_t DUID::MAX_DUID_LEN; + DUID::DUID(const std::vector<uint8_t>& data) : IdentifierType<3, 130>(data) { } @@ -32,9 +35,6 @@ const std::vector<uint8_t>& DUID::getDuid() const { return (data_); } -constexpr size_t DUID::MIN_DUID_LEN; -constexpr size_t DUID::MAX_DUID_LEN; - DUID::DUIDType DUID::getType() const { if (data_.size() < 2) { return (DUID_UNKNOWN); diff --git a/src/share/api/build-report.json b/src/share/api/build-report.json index b2ae832890..bd09c089cc 100644 --- a/src/share/api/build-report.json +++ b/src/share/api/build-report.json @@ -16,7 +16,7 @@ "resp-syntax": [ "{", " \"result\": 0,", - " \"text\": \"<string with build details>\"", + " \"text\": <string with build details>", "}" ], "support": [ diff --git a/src/share/api/cache-get-by-id.json b/src/share/api/cache-get-by-id.json index 8a014239a3..64bb8fd964 100644 --- a/src/share/api/cache-get-by-id.json +++ b/src/share/api/cache-get-by-id.json @@ -18,7 +18,7 @@ "{", " \"result\": 0,", " \"text\": \"2 entries returned.\",", - " \"arguments\": \"<list of host reservations>\"", + " \"arguments\": <list of host reservations>", "}" ], "support": [ diff --git a/src/share/api/cache-get.json b/src/share/api/cache-get.json index 55ec80e98b..0ea703edc3 100644 --- a/src/share/api/cache-get.json +++ b/src/share/api/cache-get.json @@ -10,7 +10,7 @@ "{", " \"result\": 0,", " \"text\": \"123 entries returned.\",", - " \"arguments\": \"<list of host reservations>\"", + " \"arguments\": <list of host reservations>", "}" ], "support": [ diff --git a/src/share/api/class-add.json b/src/share/api/class-add.json index 998b54a5ff..07d8762b45 100644 --- a/src/share/api/class-add.json +++ b/src/share/api/class-add.json @@ -12,13 +12,13 @@ " \"command\": \"class-add\",", " \"arguments\": {", " \"client-classes\": [ {", - " \"name\": \"<name of the class>\",", - " \"test\": \"<test expression to be evaluated on incoming packets>\",", - " \"option-data\": [ \"<option values here>\" ],", - " \"option-def\": [ \"<option definitions here>\" ],", - " \"next-server\": \"<ipv4 address>\",", - " \"server-hostname\": \"<string>\",", - " \"boot-file-name\": \"<name of the boot file>\"", + " \"name\": <name of the class>,", + " \"test\": <test expression to be evaluated on incoming packets>,", + " \"option-data\": [ <option values here> ],", + " \"option-def\": [ <option definitions here> ],", + " \"next-server\": <ipv4 address>,", + " \"server-hostname\": <string>,", + " \"boot-file-name\": <name of the boot file>", " } ]", " }", "}" diff --git a/src/share/api/class-del.json b/src/share/api/class-del.json index df417af149..38c4818659 100644 --- a/src/share/api/class-del.json +++ b/src/share/api/class-del.json @@ -8,7 +8,7 @@ "{", " \"command\": \"class-del\",", " \"arguments\": {", - " \"name\": \"<name of the class>\"", + " \"name\": <name of the class>", " }", "}" ], diff --git a/src/share/api/class-get.json b/src/share/api/class-get.json index e1cb1fe03b..1d7c5b2906 100644 --- a/src/share/api/class-get.json +++ b/src/share/api/class-get.json @@ -8,7 +8,7 @@ "{", " \"command\": \"class-get\",", " \"arguments\": {", - " \"name\": \"<name of the class>\"", + " \"name\": <name of the class>", " }", "}" ], @@ -25,14 +25,14 @@ " \"arguments\": {", " \"client-classes\": [", " {", - " \"name\": \"<name of the class>\",", - " \"only-if-required\": \"<only if required boolean value>\",", - " \"test\": \"<test expression to be evaluated on incoming packets>\",", - " \"option-data\": [ \"<option values here>\" ],", - " \"option-def\": [ \"<option definitions here>\" ],", - " \"next-server\": \"<ipv4 address>\",", - " \"server-hostname\": \"<string>\",", - " \"boot-file-name\": \"<name of the boot file>\"", + " \"name\": <name of the class>,", + " \"only-if-required\": <only if required boolean value>,", + " \"test\": <test expression to be evaluated on incoming packets>,", + " \"option-data\": [ <option values here> ],", + " \"option-def\": [ <option definitions here> ],", + " \"next-server\": <ipv4 address>,", + " \"server-hostname\": <string>,", + " \"boot-file-name\": <name of the boot file>", " }", " ]", " }", diff --git a/src/share/api/class-list.json b/src/share/api/class-list.json index 8383dff8af..17544c89b2 100644 --- a/src/share/api/class-list.json +++ b/src/share/api/class-list.json @@ -32,10 +32,10 @@ " \"arguments\": {", " \"client-classes\": [", " {", - " \"name\": \"<first class name>\"", + " \"name\": <first class name>", " },", " {", - " \"name\": \"<second class name>\"", + " \"name\": <second class name>", " }", " ]", " }", diff --git a/src/share/api/class-update.json b/src/share/api/class-update.json index a5e09dcadd..c3b8284f9a 100644 --- a/src/share/api/class-update.json +++ b/src/share/api/class-update.json @@ -12,13 +12,13 @@ " \"command\": \"class-update\",", " \"arguments\": {", " \"client-classes\": [ {", - " \"name\": \"<name of the class>\",", - " \"test\": \"<test expression to be evaluated on incoming packets>\",", - " \"option-data\": [ \"<option values here>\" ],", - " \"option-def\": [ \"<option definitions here>\" ],", - " \"next-server\": \"<ipv4 address>\",", - " \"server-hostname\": \"<string>\",", - " \"boot-file-name\": \"<name of the boot file>\"", + " \"name\": <name of the class>,", + " \"test\": <test expression to be evaluated on incoming packets>,", + " \"option-data\": [ <option values here> ],", + " \"option-def\": [ <option definitions here> ],", + " \"next-server\": <ipv4 address>,", + " \"server-hostname\": <string>,", + " \"boot-file-name\": <name of the boot file>", " } ]", " }", "}" diff --git a/src/share/api/config-get.json b/src/share/api/config-get.json index da749d83d8..3a49afbaff 100644 --- a/src/share/api/config-get.json +++ b/src/share/api/config-get.json @@ -15,9 +15,9 @@ "name": "config-get", "resp-syntax": [ "{", - " \"result\": \"<integer>\",", + " \"result\": <integer>,", " \"arguments\": {", - " \"<Dhcp4, Dhcp6, or Control-agent object>\": \"<JSON configuration here>\" ", + " <Dhcp4, Dhcp6, or Control-agent object>: <JSON configuration here> ", " }", "}" ], diff --git a/src/share/api/config-test.json b/src/share/api/config-test.json index c0a0f43759..fef0e1ad93 100644 --- a/src/share/api/config-test.json +++ b/src/share/api/config-test.json @@ -5,7 +5,7 @@ "This command instructs the server to check whether the new configuration supplied in the command's arguments can be loaded." ], "cmd-comment": [ - "In the example below, \"<server>\" is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\"." + "In the example below, <server> is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\"." ], "cmd-syntax": [ "{", diff --git a/src/share/api/ha-heartbeat.json b/src/share/api/ha-heartbeat.json index 535fd229d1..f7f0539958 100644 --- a/src/share/api/ha-heartbeat.json +++ b/src/share/api/ha-heartbeat.json @@ -20,10 +20,10 @@ " \"result\": 0,", " \"text\": \"HA peer status returned.\",", " \"arguments\": {", - " \"state\": \"<server state>\",", - " \"date-time\": \"<server notion of time>\",", - " \"scopes\": [ \"<first scope>, <second scope>\" ],", - " \"unsent-update-count\": \"<total number of lease allocations in partner-down state>\"", + " \"state\": <server state>,", + " \"date-time\": <server notion of time>,", + " \"scopes\": [ <first scope>, <second scope>, ... ],", + " \"unsent-update-count\": <total number of lease allocations in partner-down state>", " }", "}" ], diff --git a/src/share/api/ha-maintenance-notify.json b/src/share/api/ha-maintenance-notify.json index c8ab4ff823..d187107f15 100644 --- a/src/share/api/ha-maintenance-notify.json +++ b/src/share/api/ha-maintenance-notify.json @@ -19,7 +19,7 @@ "{", " \"command\": \"ha-maintenance-notify\",", " \"arguments\": {", - " \"cancel\": \"<boolean>\"", + " \"cancel\": <boolean>", " }", "}" ], diff --git a/src/share/api/ha-scopes.json b/src/share/api/ha-scopes.json index d988933de5..99240aa695 100644 --- a/src/share/api/ha-scopes.json +++ b/src/share/api/ha-scopes.json @@ -10,7 +10,7 @@ "cmd-syntax": [ "{", " \"command\": \"ha-scopes\",", - " \"service\": [ \"<service, typically 'dhcp4' or 'dhcp6'>\" ],", + " \"service\": [ <service, typically 'dhcp4' or 'dhcp6'> ],", " \"arguments\": {", " \"scopes\": [ \"HA_server1\", \"HA_server2\" ]", " }", diff --git a/src/share/api/ha-sync.json b/src/share/api/ha-sync.json index d15d7f2448..b4e427719a 100644 --- a/src/share/api/ha-sync.json +++ b/src/share/api/ha-sync.json @@ -7,10 +7,10 @@ "cmd-syntax": [ "{", " \"command\": \"ha-sync\",", - " \"service\": [ \"<service affected: 'dhcp4' or 'dhcp6'>\" ],", + " \"service\": [ <service affected: 'dhcp4' or 'dhcp6'> ],", " \"arguments\": {", - " \"server-name\": \"<name of the partner server>\",", - " \"max-period\": \"<integer, in seconds>\"", + " \"server-name\": <name of the partner server>,", + " \"max-period\": <integer, in seconds>", " }", "}" ], diff --git a/src/share/api/lease4-get-all.json b/src/share/api/lease4-get-all.json index f954968689..117995b7e0 100644 --- a/src/share/api/lease4-get-all.json +++ b/src/share/api/lease4-get-all.json @@ -13,7 +13,7 @@ "{", " \"command\": \"lease4-get-all\",", " \"arguments\": {", - " \"subnets\": [ 1, 2, 3 ]", + " \"subnets\": [ 1, 2, 3, ... ]", " }", "}" ], diff --git a/src/share/api/lease4-get-page.json b/src/share/api/lease4-get-page.json index 12d048fcff..741215025d 100644 --- a/src/share/api/lease4-get-page.json +++ b/src/share/api/lease4-get-page.json @@ -11,8 +11,8 @@ "{", " \"command\": \"lease4-get-page\",", " \"arguments\": {", - " \"limit\": \"<integer>\",", - " \"from\": \"<IPv4 address or 'start'>\"", + " \"limit\": <integer>,", + " \"from\": <IPv4 address or 'start'>", " }", "}" ], diff --git a/src/share/api/lease6-bulk-apply.json b/src/share/api/lease6-bulk-apply.json index e417b80e79..db86b655d0 100644 --- a/src/share/api/lease6-bulk-apply.json +++ b/src/share/api/lease6-bulk-apply.json @@ -15,12 +15,12 @@ " {", " \"ip-address\": \"2001:db8:abcd::\",", " \"type\": \"IA_PD\",", - " \"<other\": \"properties>\"", + " ...", " },", " {", " \"ip-address\": \"2001:db8:abcd::234\",", " \"type\": \"IA_NA\",", - " \"<other\": \"properties>\"", + " ...", " }", " ],", " \"leases\": [", @@ -28,13 +28,13 @@ " \"subnet-id\": 66,", " \"ip-address\": \"2001:db8:cafe::\",", " \"type\": \"IA_PD\",", - " \"<other\": \"properties>\"", + " ...", " },", " {", " \"subnet-id\": 66,", " \"ip-address\": \"2001:db8:abcd::333\",", " \"type\": \"IA_NA\",", - " \"<other\": \"properties>\"", + " ...", " }", " ]", " }", @@ -54,16 +54,16 @@ " {", " \"ip-address\": \"2001:db8:abcd::\",", " \"type\": \"IA_PD\",", - " \"result\": \"<control result>\",", - " \"error-message\": \"<error message>\"", + " \"result\": <control result>,", + " \"error-message\": <error message>", " }", " ],", " \"failed-leases\": [", " {", " \"ip-address\": \"2001:db8:cafe::\",", " \"type\": \"IA_PD\",", - " \"result\": \"<control result>\",", - " \"error-message\": \"<error message>\"", + " \"result\": <control result>,", + " \"error-message\": <error message>", " }", " ]", " }", diff --git a/src/share/api/lease6-get-page.json b/src/share/api/lease6-get-page.json index 6f6860cec6..dc9606bf12 100644 --- a/src/share/api/lease6-get-page.json +++ b/src/share/api/lease6-get-page.json @@ -11,8 +11,8 @@ "{", " \"command\": \"lease6-get-page\",", " \"arguments\": {", - " \"limit\": \"<integer>\",", - " \"from\": \"<IPv6 address or 'start'>\"", + " \"limit\": <integer>,", + " \"from\": <IPv6 address or 'start'>", " }", "}" ], diff --git a/src/share/api/network4-get.json b/src/share/api/network4-get.json index 3d1b42f231..84c1da9f4f 100644 --- a/src/share/api/network4-get.json +++ b/src/share/api/network4-get.json @@ -37,12 +37,12 @@ " {", " \"subnet\": \"192.0.2.0/24\",", " \"id\": 5,", - " \"<other\": \"properties>\"", + " <many other subnet specific details here>", " },", " {", " \"subnet\": \"192.0.3.0/31\",", " \"id\": 6,", - " \"<other\": \"properties>\"", + " <many other subnet specific details here>", " }", " ],", " \"valid-lifetime\": 120", diff --git a/src/share/api/network6-get.json b/src/share/api/network6-get.json index f648d8353a..f9196186eb 100644 --- a/src/share/api/network6-get.json +++ b/src/share/api/network6-get.json @@ -37,12 +37,12 @@ " {", " \"subnet\": \"2003:db8:1::/64\",", " \"id\": 5,", - " \"<other\": \"properties>\"", + " <many other subnet specific details here>", " },", " {", " \"subnet\": \"2003:db8:2::/71\",", " \"id\": 6,", - " \"<other\": \"properties>\"", + " <many other subnet specific details here>", " }", " ],", " \"valid-lifetime\": 120", diff --git a/src/share/api/remote-class4-del.json b/src/share/api/remote-class4-del.json index a9a2266530..af73605a9a 100644 --- a/src/share/api/remote-class4-del.json +++ b/src/share/api/remote-class4-del.json @@ -13,11 +13,11 @@ " \"arguments\": {", " \"client-classes\": [", " {", - " \"name\": \"<client class name>\"", + " \"name\": <client class name>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" diff --git a/src/share/api/remote-class4-get-all.json b/src/share/api/remote-class4-get-all.json index 95cce36fb2..639fc369cf 100644 --- a/src/share/api/remote-class4-get-all.json +++ b/src/share/api/remote-class4-get-all.json @@ -12,9 +12,9 @@ " \"command\": \"remote-class4-get-all\",", " \"arguments\": {", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " }", "}" ], @@ -30,15 +30,15 @@ " \"arguments\": {", " \"client-classes\": [", " {", - " \"<first\": \"client class specification>\",", + " <first client class specification>,", " \"metadata\": {", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " }", " },", " {", - " \"<second\": \"client class specification>\",", + " <second client class specification>,", " \"metadata\": {", - " \"server-tags\": [ \"<first server tag>\" ]", + " \"server-tags\": [ <first server tag>, ... ]", " }", " }", " ],", diff --git a/src/share/api/remote-class4-get.json b/src/share/api/remote-class4-get.json index 25d959d256..5dfdcb568c 100644 --- a/src/share/api/remote-class4-get.json +++ b/src/share/api/remote-class4-get.json @@ -13,11 +13,11 @@ " \"arguments\": {", " \"client-classes\": [", " {", - " \"name\": \"<client class name>\"", + " \"name\": <client class name>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" @@ -34,11 +34,11 @@ " \"arguments\": {", " \"client-classes\": [", " {", - " \"name\": \"<client class name>\",", + " \"name\": <client class name>,", " \"metadata\": {", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " },", - " \"<the\": \"rest of the client class information>\"", + " <the rest of the client class information>", " }", " ],", " \"count\": 1", diff --git a/src/share/api/remote-class4-set.json b/src/share/api/remote-class4-set.json index 7c515ff308..014071d26a 100644 --- a/src/share/api/remote-class4-set.json +++ b/src/share/api/remote-class4-set.json @@ -13,14 +13,14 @@ " \"arguments\": {", " \"client-class\": [", " {", - " \"<client\": \"class specification>\",", - " \"follow-class-name\": \"<existing class name>\"", + " <client class specification>,", + " \"follow-class-name\": <existing class name>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " }", "}" ], @@ -33,7 +33,7 @@ " \"arguments\": {", " \"client-classes\": [", " {", - " \"name\": \"<set client class name>\"", + " \"name\": <set client class name>", " }", " ]", " }", diff --git a/src/share/api/remote-class6-del.json b/src/share/api/remote-class6-del.json index 4b79bf21f8..f74578da94 100644 --- a/src/share/api/remote-class6-del.json +++ b/src/share/api/remote-class6-del.json @@ -13,11 +13,11 @@ " \"arguments\": {", " \"client-classes\": [", " {", - " \"name\": \"<client class name>\"", + " \"name\": <client class name>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" diff --git a/src/share/api/remote-class6-get-all.json b/src/share/api/remote-class6-get-all.json index 90185ee0af..216611c77b 100644 --- a/src/share/api/remote-class6-get-all.json +++ b/src/share/api/remote-class6-get-all.json @@ -12,9 +12,9 @@ " \"command\": \"remote-class6-get-all\",", " \"arguments\": {", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " }", "}" ], @@ -30,15 +30,15 @@ " \"arguments\": {", " \"client-classes\": [", " {", - " \"<first\": \"client class specification>\",", + " <first client class specification>,", " \"metadata\": {", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " }", " },", " {", - " \"<second\": \"client class specification>\",", + " <second client class specification>,", " \"metadata\": {", - " \"server-tags\": [ \"<first server tag>\" ]", + " \"server-tags\": [ <first server tag>, ... ]", " }", " }", " ],", diff --git a/src/share/api/remote-class6-get.json b/src/share/api/remote-class6-get.json index b8d4fe54c8..bf90fbeb5b 100644 --- a/src/share/api/remote-class6-get.json +++ b/src/share/api/remote-class6-get.json @@ -13,11 +13,11 @@ " \"arguments\": {", " \"client-classes\": [", " {", - " \"name\": \"<client class name>\"", + " \"name\": <client class name>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" @@ -34,11 +34,11 @@ " \"arguments\": {", " \"client-classes\": [", " {", - " \"name\": \"<client class name>\",", + " \"name\": <client class name>,", " \"metadata\": {", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " },", - " \"<the\": \"rest of the client class information>\"", + " <the rest of the client class information>", " }", " ],", " \"count\": 1", diff --git a/src/share/api/remote-class6-set.json b/src/share/api/remote-class6-set.json index b560972be2..1c2fed8059 100644 --- a/src/share/api/remote-class6-set.json +++ b/src/share/api/remote-class6-set.json @@ -13,14 +13,14 @@ " \"arguments\": {", " \"client-class\": [", " {", - " \"<client\": \"class specification>\",", - " \"follow-class-name\": \"<existing class name>\"", + " <client class specification>,", + " \"follow-class-name\": <existing class name>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " }", "}" ], @@ -33,7 +33,7 @@ " \"arguments\": {", " \"client-classes\": [", " {", - " \"name\": \"<set client class name>\"", + " \"name\": <set client class name>", " }", " ]", " }", diff --git a/src/share/api/remote-global-parameter4-del.json b/src/share/api/remote-global-parameter4-del.json index ca0e61f038..3c1564a08d 100644 --- a/src/share/api/remote-global-parameter4-del.json +++ b/src/share/api/remote-global-parameter4-del.json @@ -11,11 +11,11 @@ "{", " \"command\": \"remote-global-parameter4-del\",", " \"arguments\": {", - " \"parameters\": [ \"<parameter name as string>\" ],", + " \"parameters\": [ <parameter name as string> ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<single server tag as string>\" ]", + " \"server-tags\": [ <single server tag as string> ]", " }", "}" ], diff --git a/src/share/api/remote-global-parameter4-get-all.json b/src/share/api/remote-global-parameter4-get-all.json index 666dd79425..1eb4297001 100644 --- a/src/share/api/remote-global-parameter4-get-all.json +++ b/src/share/api/remote-global-parameter4-get-all.json @@ -12,9 +12,9 @@ " \"command\": \"remote-global-parameter4-get-all\",", " \"arguments\": {", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<single server tag as string>\" ]", + " \"server-tags\": [ <single server tag as string> ]", " }", "}" ], @@ -30,15 +30,15 @@ " \"arguments\": {", " \"parameters\": [", " {", - " \"<first\": \"parameter name>: <first parameter value>\",", + " <first parameter name>: <first parameter value>,", " \"metadata\": {", - " \"server-tags\": [ \"<server tag>\" ]", + " \"server-tags\": [ <server tag> ]", " }", " },", " {", - " \"<second\": \"parameter name>: <second parameter value>\",", + " <second parameter name>: <second parameter value>,", " \"metadata\": {", - " \"server-tags\": [ \"<server tag>\" ]", + " \"server-tags\": [ <server tag> ]", " }", " }", " ],", diff --git a/src/share/api/remote-global-parameter4-get.json b/src/share/api/remote-global-parameter4-get.json index f6848fa96e..1d7f09bbd6 100644 --- a/src/share/api/remote-global-parameter4-get.json +++ b/src/share/api/remote-global-parameter4-get.json @@ -11,11 +11,11 @@ "{", " \"command\": \"remote-global-parameter4-get\",", " \"arguments\": {", - " \"parameters\": [ \"<parameter name as string>\" ],", + " \"parameters\": [ <parameter name as string> ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<single server tag as string>\" ]", + " \"server-tags\": [ <single server tag as string> ]", " }", "}" ], @@ -30,9 +30,9 @@ " \"text\": \"DHCPv4 global parameter found.\",", " \"arguments\": {", " \"parameters\": {", - " \"<parameter\" :\" name>: <parameter value>\",", + " <parameter name>: <parameter value>,", " \"metadata\": {", - " \"server-tags\": [ \"<server tag>\" ]", + " \"server-tags\": [ <server tag> ]", " }", " },", " \"count\": 1", diff --git a/src/share/api/remote-global-parameter4-set.json b/src/share/api/remote-global-parameter4-set.json index 73bce1e291..d09af68713 100644 --- a/src/share/api/remote-global-parameter4-set.json +++ b/src/share/api/remote-global-parameter4-set.json @@ -12,13 +12,13 @@ " \"command\": \"remote-global-parameter4-set\",", " \"arguments\": {", " \"parameters\": {", - " \"<first\": \"parameter name>: <first parameter value>\",", - " \"<second\": \"parameter name>: <second parameter value>\"", + " <first parameter name>: <first parameter value>,", + " <second parameter name>: <second parameter value>", " },", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<single server tag as string>\" ]", + " \"server-tags\": [ <single server tag as string> ]", " }", "}" ], @@ -30,8 +30,8 @@ " \"text\": \"DHCPv4 global parameter(s) successfully set.\",", " \"arguments\": {", " \"parameters\": {", - " \"<first\": \"parameter name>: <first parameter value>\",", - " \"<second\": \"parameter name>: <second parameter value>\"", + " <first parameter name>: <first parameter value>,", + " <second parameter name>: <second parameter value>", " },", " \"count\": 2", " }", diff --git a/src/share/api/remote-global-parameter6-del.json b/src/share/api/remote-global-parameter6-del.json index 4fbabf92b8..545921ef99 100644 --- a/src/share/api/remote-global-parameter6-del.json +++ b/src/share/api/remote-global-parameter6-del.json @@ -11,11 +11,11 @@ "{", " \"command\": \"remote-global-parameter6-del\",", " \"arguments\": {", - " \"parameters\": [ \"<parameter name as string>\" ],", + " \"parameters\": [ <parameter name as string> ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<single server tag as string>\" ]", + " \"server-tags\": [ <single server tag as string> ]", " }", "}" ], diff --git a/src/share/api/remote-global-parameter6-get-all.json b/src/share/api/remote-global-parameter6-get-all.json index f8072e0ac7..12d8541330 100644 --- a/src/share/api/remote-global-parameter6-get-all.json +++ b/src/share/api/remote-global-parameter6-get-all.json @@ -12,9 +12,9 @@ " \"command\": \"remote-global-parameter6-get-all\",", " \"arguments\": {", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<single server tag as string>\" ]", + " \"server-tags\": [ <single server tag as string> ]", " }", "}" ], @@ -30,15 +30,15 @@ " \"arguments\": {", " \"parameters\": [", " {", - " \"<first\": \"parameter name>: <first parameter value>\",", + " <first parameter name>: <first parameter value>,", " \"metadata\": {", - " \"server-tags\": [ \"<server tag>\" ]", + " \"server-tags\": [ <server tag> ]", " }", " },", " {", - " \"<second\": \"parameter name>: <second parameter value>\",", + " <second parameter name>: <second parameter value>,", " \"metadata\": {", - " \"server-tags\": [ \"<server tag>\" ]", + " \"server-tags\": [ <server tag> ]", " }", " }", " ],", diff --git a/src/share/api/remote-global-parameter6-get.json b/src/share/api/remote-global-parameter6-get.json index 293a1e96d8..4c3975eabf 100644 --- a/src/share/api/remote-global-parameter6-get.json +++ b/src/share/api/remote-global-parameter6-get.json @@ -11,11 +11,11 @@ "{", " \"command\": \"remote-global-parameter6-get\",", " \"arguments\": {", - " \"parameters\": [ \"<parameter name as string>\" ],", + " \"parameters\": [ <parameter name as string> ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<single server tag as string>\" ]", + " \"server-tags\": [ <single server tag as string> ]", " }", "}" ], @@ -30,9 +30,9 @@ " \"text\": \"DHCPv6 global parameter found.\",", " \"arguments\": {", " \"parameters\": {", - " \"<parameter\": \"name>: <parameter value>\",", + " <parameter name>: <parameter value>,", " \"metadata\": {", - " \"server-tags\": [ \"<server tag>\" ]", + " \"server-tags\": [ <server tag> ]", " }", " },", " \"count\": 1", diff --git a/src/share/api/remote-global-parameter6-set.json b/src/share/api/remote-global-parameter6-set.json index 270079338a..2f1fc6770a 100644 --- a/src/share/api/remote-global-parameter6-set.json +++ b/src/share/api/remote-global-parameter6-set.json @@ -12,13 +12,13 @@ " \"command\": \"remote-global-parameter6-set\",", " \"arguments\": {", " \"parameters\": {", - " \"<first\": \"parameter name>: <first parameter value>\",", - " \"<second\": \"parameter name>: <second parameter value>\"", + " <first parameter name>: <first parameter value>,", + " <second parameter name>: <second parameter value>", " },", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<single server tag as string>\" ]", + " \"server-tags\": [ <single server tag as string> ]", " }", "}" ], @@ -30,8 +30,8 @@ " \"text\": \"DHCPv6 global parameter(s) successfully set.\",", " \"arguments\": {", " \"parameters\": {", - " \"<first\": \"parameter name>: <first parameter value>\",", - " \"<second\": \"parameter name>: <second parameter value>\"", + " <first parameter name>: <first parameter value>,", + " <second parameter name>: <second parameter value>", " },", " \"count\": 2", " }", diff --git a/src/share/api/remote-network4-del.json b/src/share/api/remote-network4-del.json index d0d0f7d7d2..2c3b5c8c91 100644 --- a/src/share/api/remote-network4-del.json +++ b/src/share/api/remote-network4-del.json @@ -13,12 +13,12 @@ " \"arguments\": {", " \"shared-networks\": [", " {", - " \"name\": \"<shared network name>\"", + " \"name\": <shared network name>", " }", " ],", - " \"subnets-action\": \"<'keep' | 'delete'>\",", + " \"subnets-action\": <'keep' | 'delete'>,", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" diff --git a/src/share/api/remote-network4-get.json b/src/share/api/remote-network4-get.json index 8d5cd6f2e1..5ad6b488e8 100644 --- a/src/share/api/remote-network4-get.json +++ b/src/share/api/remote-network4-get.json @@ -13,12 +13,12 @@ " \"arguments\": {", " \"shared-networks\": [", " {", - " \"name\": \"<shared network name>\"", + " \"name\": <shared network name>", " }", " ],", - " \"subnets-include\": \"<'full' | 'no'>\",", + " \"subnets-include\": <'full' | 'no'>,", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" @@ -35,11 +35,11 @@ " \"arguments\": {", " \"shared-networks\": [", " {", - " \"name\": \"<shared network name>\",", + " \"name\": <shared network name>,", " \"metadata\": {", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " },", - " \"<the\": \"rest of the shared network information, potentially including subnets>\"", + " <the rest of the shared network information, potentially including subnets>", " }", " ],", " \"count\": 1", diff --git a/src/share/api/remote-network4-list.json b/src/share/api/remote-network4-list.json index bcf183ff51..db10c684d8 100644 --- a/src/share/api/remote-network4-list.json +++ b/src/share/api/remote-network4-list.json @@ -12,9 +12,9 @@ " \"command\": \"remote-network4-list\",", " \"arguments\": {", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " }", "}" ], @@ -30,15 +30,15 @@ " \"arguments\": {", " \"shared-networks\": [", " {", - " \"name\": \"<first shared network name>\",", + " \"name\": <first shared network name>,", " \"metadata\": {", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " }", " },", " {", - " \"name\": \"<second shared network name>\",", + " \"name\": <second shared network name>,", " \"metadata\": {", - " \"server-tags\": [ \"<first server tag>\" ]", + " \"server-tags\": [ <first server tag>, ... ]", " }", " }", " ],", diff --git a/src/share/api/remote-network4-set.json b/src/share/api/remote-network4-set.json index 0ba7d9d0fb..5f2969d985 100644 --- a/src/share/api/remote-network4-set.json +++ b/src/share/api/remote-network4-set.json @@ -13,13 +13,13 @@ " \"arguments\": {", " \"shared-networks\": [", " {", - " \"<shared\": \"network specification excluding subnets list>\"", + " <shared network specification excluding subnets list>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " }", "}" ], diff --git a/src/share/api/remote-network6-del.json b/src/share/api/remote-network6-del.json index 8a05909f93..2d0cf17598 100644 --- a/src/share/api/remote-network6-del.json +++ b/src/share/api/remote-network6-del.json @@ -13,12 +13,12 @@ " \"arguments\": {", " \"shared-networks\": [", " {", - " \"name\": \"<shared network name>\"", + " \"name\": <shared network name>", " }", " ],", - " \"subnets-action\": \"<'keep' | 'delete'>\",", + " \"subnets-action\": <'keep' | 'delete'>,", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" diff --git a/src/share/api/remote-network6-get.json b/src/share/api/remote-network6-get.json index 0840b1b92f..2ba0274f3e 100644 --- a/src/share/api/remote-network6-get.json +++ b/src/share/api/remote-network6-get.json @@ -13,12 +13,12 @@ " \"arguments\": {", " \"shared-networks\": [", " {", - " \"name\": \"<shared network name>\"", + " \"name\": <shared network name>", " }", " ],", - " \"subnets-include\": \"<'full' | 'no'>\",", + " \"subnets-include\": <'full' | 'no'>,", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" @@ -35,11 +35,11 @@ " \"arguments\": {", " \"shared-networks\": [", " {", - " \"name\": \"<shared network name>\",", + " \"name\": <shared network name>,", " \"metadata\": {", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " },", - " \"<the\": \"rest of the shared network information, potentially including subnets>\"", + " <the rest of the shared network information, potentially including subnets>", " }", " ],", " \"count\": 1", diff --git a/src/share/api/remote-network6-list.json b/src/share/api/remote-network6-list.json index e1e8d80556..107ba80ebd 100644 --- a/src/share/api/remote-network6-list.json +++ b/src/share/api/remote-network6-list.json @@ -12,9 +12,9 @@ " \"command\": \"remote-network6-list\",", " \"arguments\": {", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " }", "}" ], @@ -30,15 +30,15 @@ " \"arguments\": {", " \"shared-networks\": [", " {", - " \"name\": \"<first shared network name>\",", + " \"name\": <first shared network name>,", " \"metadata\": {", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " }", " },", " {", - " \"name\": \"<second shared network name>\",", + " \"name\": <second shared network name>,", " \"metadata\": {", - " \"server-tags\": [ \"<first server tag>\" ]", + " \"server-tags\": [ <first server tag>, ... ]", " }", " }", " ],", diff --git a/src/share/api/remote-network6-set.json b/src/share/api/remote-network6-set.json index 217cdb13b7..a540124be8 100644 --- a/src/share/api/remote-network6-set.json +++ b/src/share/api/remote-network6-set.json @@ -13,13 +13,13 @@ " \"arguments\": {", " \"shared-networks\": [", " {", - " \"<shared\": \"network specification excluding subnets list>\"", + " <shared network specification excluding subnets list>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " }", "}" ], diff --git a/src/share/api/remote-option-def4-del.json b/src/share/api/remote-option-def4-del.json index 83b64ba50b..9c8efca6b0 100644 --- a/src/share/api/remote-option-def4-del.json +++ b/src/share/api/remote-option-def4-del.json @@ -12,13 +12,13 @@ " \"command\": \"remote-option-def4-del\",", " \"arguments\": {", " \"option-defs\": [ {", - " \"code\": \"<option code>\",", - " \"space\": \"<option space>\"", + " \"code\": <option code>,", + " \"space\": <option space>", " } ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<single server tag as string>\" ]", + " \"server-tags\": [ <single server tag as string> ]", " }", "}" ], diff --git a/src/share/api/remote-option-def4-get-all.json b/src/share/api/remote-option-def4-get-all.json index b13cb23b9d..df6752ddcd 100644 --- a/src/share/api/remote-option-def4-get-all.json +++ b/src/share/api/remote-option-def4-get-all.json @@ -12,9 +12,9 @@ " \"command\": \"remote-option-def4-get-all\",", " \"arguments\": {", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<single server tag as string>\" ]", + " \"server-tags\": [ <single server tag as string> ]", " }", "}" ], @@ -30,15 +30,15 @@ " \"arguments\": {", " \"option-defs\": [", " {", - " \"<first\": \"option definition>\",", + " <first option definition>,", " \"metadata\": {", - " \"server-tags\": [ \"<server tag>\" ]", + " \"server-tags\": [ <server tag> ]", " }", " },", " {", - " \"<second\": \"option definition>\",", + " <second option definition>,", " \"metadata\": {", - " \"server-tags\": [ \"<server tag>\" ]", + " \"server-tags\": [ <server tag> ]", " }", " }", " ],", diff --git a/src/share/api/remote-option-def4-get.json b/src/share/api/remote-option-def4-get.json index 2441eb5dba..c48fda4db1 100644 --- a/src/share/api/remote-option-def4-get.json +++ b/src/share/api/remote-option-def4-get.json @@ -13,14 +13,14 @@ " \"arguments\": {", " \"option-defs\": [", " {", - " \"code\": \"<option code>\",", - " \"space\": \"<option space>\"", + " \"code\": <option code>,", + " \"space\": <option space>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<single server tag as string>\" ]", + " \"server-tags\": [ <single server tag as string> ]", " }", "}" ], @@ -36,9 +36,9 @@ " \"arguments\": {", " \"option-defs\": [", " {", - " \"<option\": \"definition>\",", + " <option definition>,", " \"metadata\": {", - " \"server-tags\": [ \"<server tag>\" ]", + " \"server-tags\": [ <server tag> ]", " }", " }", " ],", diff --git a/src/share/api/remote-option-def4-set.json b/src/share/api/remote-option-def4-set.json index f28f145331..78a27e8630 100644 --- a/src/share/api/remote-option-def4-set.json +++ b/src/share/api/remote-option-def4-set.json @@ -13,13 +13,13 @@ " \"arguments\": {", " \"option-defs\": [", " {", - " \"<option\": \"definition specification>\"", + " <option definition specification>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<single server tag as string>\" ]", + " \"server-tags\": [ <single server tag as string> ]", " }", "}" ], diff --git a/src/share/api/remote-option-def6-del.json b/src/share/api/remote-option-def6-del.json index b6fac51113..9121c6eca6 100644 --- a/src/share/api/remote-option-def6-del.json +++ b/src/share/api/remote-option-def6-del.json @@ -12,13 +12,13 @@ " \"command\": \"remote-option-def6-del\",", " \"arguments\": {", " \"option-defs\": [ {", - " \"code\": \"<option code>\",", - " \"space\": \"<option space>\"", + " \"code\": <option code>,", + " \"space\": <option space>", " } ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<single server tag as string>\" ]", + " \"server-tags\": [ <single server tag as string> ]", " }", "}" ], diff --git a/src/share/api/remote-option-def6-get-all.json b/src/share/api/remote-option-def6-get-all.json index 9f5304842b..9d6435802a 100644 --- a/src/share/api/remote-option-def6-get-all.json +++ b/src/share/api/remote-option-def6-get-all.json @@ -12,9 +12,9 @@ " \"command\": \"remote-option-def6-get-all\",", " \"arguments\": {", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<single server tag as string>\" ]", + " \"server-tags\": [ <single server tag as string> ]", " }", "}" ], @@ -30,15 +30,15 @@ " \"arguments\": {", " \"option-defs\": [", " {", - " \"<first\": \"option definition>\",", + " <first option definition>,", " \"metadata\": {", - " \"server-tags\": [ \"<server tag>\" ]", + " \"server-tags\": [ <server tag> ]", " }", " },", " {", - " \"<second\": \"option definition>\",", + " <second option definition>,", " \"metadata\": {", - " \"server-tags\": [ \"<server tag>\" ]", + " \"server-tags\": [ <server tag> ]", " }", " }", " ],", diff --git a/src/share/api/remote-option-def6-get.json b/src/share/api/remote-option-def6-get.json index d90a8783c2..f7c58956df 100644 --- a/src/share/api/remote-option-def6-get.json +++ b/src/share/api/remote-option-def6-get.json @@ -13,14 +13,14 @@ " \"arguments\": {", " \"option-defs\": [", " {", - " \"code\": \"<option code>\",", - " \"space\": \"<option space>\"", + " \"code\": <option code>,", + " \"space\": <option space>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<single server tag as string>\" ]", + " \"server-tags\": [ <single server tag as string> ]", " }", "}" ], @@ -36,9 +36,9 @@ " \"arguments\": {", " \"option-defs\": [", " {", - " \"<option\": \"definition>\",", + " <option definition>,", " \"metadata\": {", - " \"server-tags\": [ \"<server tag>\" ]", + " \"server-tags\": [ <server tag> ]", " }", " }", " ],", diff --git a/src/share/api/remote-option-def6-set.json b/src/share/api/remote-option-def6-set.json index 178fb884cb..1a32e821a9 100644 --- a/src/share/api/remote-option-def6-set.json +++ b/src/share/api/remote-option-def6-set.json @@ -13,13 +13,13 @@ " \"arguments\": {", " \"option-defs\": [", " {", - " \"<option\": \"definition specification>\"", + " <option definition specification>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<single server tag as string>\" ]", + " \"server-tags\": [ <single server tag as string> ]", " }", "}" ], diff --git a/src/share/api/remote-option4-global-del.json b/src/share/api/remote-option4-global-del.json index a3d2c26b19..15b88dbdc1 100644 --- a/src/share/api/remote-option4-global-del.json +++ b/src/share/api/remote-option4-global-del.json @@ -13,14 +13,14 @@ " \"arguments\": {", " \"options\": [", " {", - " \"code\": \"<option code>\",", - " \"space\": \"<option space>\"", + " \"code\": <option code>,", + " \"space\": <option space>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<single server tag as string>\" ]", + " \"server-tags\": [ <single server tag as string> ]", " }", "}" ], diff --git a/src/share/api/remote-option4-global-get-all.json b/src/share/api/remote-option4-global-get-all.json index 49d296f4ae..d64ff312dc 100644 --- a/src/share/api/remote-option4-global-get-all.json +++ b/src/share/api/remote-option4-global-get-all.json @@ -12,9 +12,9 @@ " \"command\": \"remote-option4-global-get-all\",", " \"arguments\": {", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<single server tag as string>\" ]", + " \"server-tags\": [ <single server tag as string> ]", " }", "}" ], @@ -30,15 +30,15 @@ " \"arguments\": {", " \"options\": [", " {", - " \"<first\": \"option specification>\",", + " <first option specification>,", " \"metadata\": {", - " \"server-tags\": [ \"<server tag>\" ]", + " \"server-tags\": [ <server tag> ]", " }", " },", " {", - " \"<second\": \"option specification>\",", + " <second option specification>,", " \"metadata\": {", - " \"server-tags\": [ \"<server tag>\" ]", + " \"server-tags\": [ <server tag> ]", " }", " }", " ],", diff --git a/src/share/api/remote-option4-global-get.json b/src/share/api/remote-option4-global-get.json index 4f38e74d05..f6a11bfb0f 100644 --- a/src/share/api/remote-option4-global-get.json +++ b/src/share/api/remote-option4-global-get.json @@ -13,14 +13,14 @@ " \"arguments\": {", " \"options\": [", " {", - " \"code\": \"<option code>\",", - " \"space\": \"<option space>\"", + " \"code\": <option code>,", + " \"space\": <option space>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<single server tag as string>\" ]", + " \"server-tags\": [ <single server tag as string> ]", " }", "}" ], @@ -36,9 +36,9 @@ " \"arguments\": {", " \"options\": [", " {", - " \"<option\": \"information>\",", + " <option information>,", " \"metadata\": {", - " \"server-tags\": [ \"<server tag>\" ]", + " \"server-tags\": [ <server tag> ]", " }", " }", " ]", diff --git a/src/share/api/remote-option4-global-set.json b/src/share/api/remote-option4-global-set.json index 10b099d0cc..32c1611cb5 100644 --- a/src/share/api/remote-option4-global-set.json +++ b/src/share/api/remote-option4-global-set.json @@ -13,13 +13,13 @@ " \"arguments\": {", " \"options\": [", " {", - " \"<global\": \"option specification>\"", + " <global option specification>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<single server tag as string>\" ]", + " \"server-tags\": [ <single server tag as string> ]", " }", "}" ], @@ -32,8 +32,8 @@ " \"arguments\": {", " \"options\": [", " {", - " \"code\": \"<option code>\",", - " \"space\": \"<option space>\"", + " \"code\": <option code>,", + " \"space\": <option space>", " }", " ]", " }", diff --git a/src/share/api/remote-option4-network-del.json b/src/share/api/remote-option4-network-del.json index 6dbf125e47..6ba9f99f02 100644 --- a/src/share/api/remote-option4-network-del.json +++ b/src/share/api/remote-option4-network-del.json @@ -13,17 +13,17 @@ " \"arguments\": {", " \"shared-networks\": [", " {", - " \"name\": \"<shared network name>\"", + " \"name\": <shared network name>", " }", " ],", " \"options\": [", " {", - " \"code\": \"<option code>\",", - " \"space\": \"<option space>\"", + " \"code\": <option code>,", + " \"space\": <option space>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" diff --git a/src/share/api/remote-option4-network-set.json b/src/share/api/remote-option4-network-set.json index 5bd2c42493..ad9cc06cfa 100644 --- a/src/share/api/remote-option4-network-set.json +++ b/src/share/api/remote-option4-network-set.json @@ -13,16 +13,16 @@ " \"arguments\": {", " \"shared-networks\": [", " {", - " \"name\": \"<shared network name>\"", + " \"name\": <shared network name>", " }", " ],", " \"options\": [", " {", - " \"<shared\": \"network option specification>\"", + " <shared network option specification>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" @@ -36,8 +36,8 @@ " \"arguments\": {", " \"options\": [", " {", - " \"code\": \"<option code>\",", - " \"space\": \"<option space>\"", + " \"code\": <option code>,", + " \"space\": <option space>", " }", " ]", " }", diff --git a/src/share/api/remote-option4-pool-del.json b/src/share/api/remote-option4-pool-del.json index b5b97b2ab4..b54ec2bf77 100644 --- a/src/share/api/remote-option4-pool-del.json +++ b/src/share/api/remote-option4-pool-del.json @@ -13,17 +13,17 @@ " \"arguments\": {", " \"pools\": [", " {", - " \"pool\": \"<pool range or prefix>\"", + " \"pool\": <pool range or prefix>", " }", " ],", " \"options\": [", " {", - " \"code\": \"<option code>\",", - " \"space\": \"<option space>\"", + " \"code\": <option code>,", + " \"space\": <option space>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" diff --git a/src/share/api/remote-option4-pool-set.json b/src/share/api/remote-option4-pool-set.json index c2d1895392..6567141bdd 100644 --- a/src/share/api/remote-option4-pool-set.json +++ b/src/share/api/remote-option4-pool-set.json @@ -13,16 +13,16 @@ " \"arguments\": {", " \"pools\": [", " {", - " \"pool\": \"<pool range or prefix>\"", + " \"pool\": <pool range or prefix>", " }", " ],", " \"options\": [", " {", - " \"<address\": \"pool option specification>\"", + " <address pool option specification>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" @@ -36,8 +36,8 @@ " \"arguments\": {", " \"options\": [", " {", - " \"code\": \"<option code>\",", - " \"space\": \"<option space>\"", + " \"code\": <option code>,", + " \"space\": <option space>", " }", " ]", " }", diff --git a/src/share/api/remote-option4-subnet-del.json b/src/share/api/remote-option4-subnet-del.json index 98545dbb30..c43fff853e 100644 --- a/src/share/api/remote-option4-subnet-del.json +++ b/src/share/api/remote-option4-subnet-del.json @@ -13,17 +13,17 @@ " \"arguments\": {", " \"subnets\": [", " {", - " \"id\": \"<subnet identifier>\"", + " \"id\": <subnet identifier>", " }", " ],", " \"options\": [", " {", - " \"code\": \"<option code>\",", - " \"space\": \"<option space>\"", + " \"code\": <option code>,", + " \"space\": <option space>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" diff --git a/src/share/api/remote-option4-subnet-set.json b/src/share/api/remote-option4-subnet-set.json index 100429132b..e332f7208b 100644 --- a/src/share/api/remote-option4-subnet-set.json +++ b/src/share/api/remote-option4-subnet-set.json @@ -13,16 +13,16 @@ " \"arguments\": {", " \"subnets\": [", " {", - " \"id\": \"<subnet identifier>\"", + " \"id\": <subnet identifier>", " }", " ],", " \"options\": [", " {", - " \"<subnet\": \"option specification>\"", + " <subnet option specification>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" @@ -36,8 +36,8 @@ " \"arguments\": {", " \"options\": [", " {", - " \"code\": \"<option code>\",", - " \"space\": \"<option space>\"", + " \"code\": <option code>,", + " \"space\": <option space>", " }", " ]", " }", diff --git a/src/share/api/remote-option6-global-del.json b/src/share/api/remote-option6-global-del.json index 258cfed03a..e5c3a354fe 100644 --- a/src/share/api/remote-option6-global-del.json +++ b/src/share/api/remote-option6-global-del.json @@ -13,14 +13,14 @@ " \"arguments\": {", " \"options\": [", " {", - " \"code\": \"<option code>\",", - " \"space\": \"<option space>\"", + " \"code\": <option code>,", + " \"space\": <option space>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<single server tag as string>\" ]", + " \"server-tags\": [ <single server tag as string> ]", " }", "}" ], diff --git a/src/share/api/remote-option6-global-get-all.json b/src/share/api/remote-option6-global-get-all.json index 9cccb3a78e..616354db55 100644 --- a/src/share/api/remote-option6-global-get-all.json +++ b/src/share/api/remote-option6-global-get-all.json @@ -12,9 +12,9 @@ " \"command\": \"remote-option6-global-get-all\",", " \"arguments\": {", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<single server tag as string>\" ]", + " \"server-tags\": [ <single server tag as string> ]", " }", "}" ], @@ -30,15 +30,15 @@ " \"arguments\": {", " \"options\": [", " {", - " \"<first\": \"option specification>\",", + " <first option specification>,", " \"metadata\": {", - " \"server-tags\": [ \"<server tag>\" ]", + " \"server-tags\": [ <server tag> ]", " }", " },", " {", - " \"<second\": \"option specification>\",", + " <second option specification>,", " \"metadata\": {", - " \"server-tags\": [ \"<server tag>\" ]", + " \"server-tags\": [ <server tag> ]", " }", " }", " ],", diff --git a/src/share/api/remote-option6-global-get.json b/src/share/api/remote-option6-global-get.json index 0b76884ecc..487c3de4ec 100644 --- a/src/share/api/remote-option6-global-get.json +++ b/src/share/api/remote-option6-global-get.json @@ -13,14 +13,14 @@ " \"arguments\": {", " \"options\": [", " {", - " \"code\": \"<option code>\",", - " \"space\": \"<option space>\"", + " \"code\": <option code>,", + " \"space\": <option space>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<single server tag as string>\" ]", + " \"server-tags\": [ <single server tag as string> ]", " }", "}" ], @@ -36,9 +36,9 @@ " \"arguments\": {", " \"options\": [", " {", - " \"<option\": \"information>\",", + " <option information>,", " \"metadata\": {", - " \"server-tags\": [ \"<server tag>\" ]", + " \"server-tags\": [ <server tag> ]", " }", " }", " ]", diff --git a/src/share/api/remote-option6-global-set.json b/src/share/api/remote-option6-global-set.json index e0cedb52ce..27274038b6 100644 --- a/src/share/api/remote-option6-global-set.json +++ b/src/share/api/remote-option6-global-set.json @@ -13,13 +13,13 @@ " \"arguments\": {", " \"options\": [", " {", - " \"<global\": \"option specification>\"", + " <global option specification>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<single server tag as string>\" ]", + " \"server-tags\": [ <single server tag as string> ]", " }", "}" ], @@ -32,8 +32,8 @@ " \"arguments\": {", " \"options\": [", " {", - " \"code\": \"<option code>\",", - " \"space\": \"<option space>\"", + " \"code\": <option code>,", + " \"space\": <option space>", " }", " ]", " }", diff --git a/src/share/api/remote-option6-network-del.json b/src/share/api/remote-option6-network-del.json index fa1301542f..6a81929065 100644 --- a/src/share/api/remote-option6-network-del.json +++ b/src/share/api/remote-option6-network-del.json @@ -13,17 +13,17 @@ " \"arguments\": {", " \"shared-networks\": [", " {", - " \"name\": \"<shared network name>\"", + " \"name\": <shared network name>", " }", " ],", " \"options\": [", " {", - " \"code\": \"<option code>\",", - " \"space\": \"<option space>\"", + " \"code\": <option code>,", + " \"space\": <option space>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" diff --git a/src/share/api/remote-option6-network-set.json b/src/share/api/remote-option6-network-set.json index 11a27ef536..ab989b3b41 100644 --- a/src/share/api/remote-option6-network-set.json +++ b/src/share/api/remote-option6-network-set.json @@ -13,16 +13,16 @@ " \"arguments\": {", " \"shared-networks\": [", " {", - " \"name\": \"<shared network name>\"", + " \"name\": <shared network name>", " }", " ],", " \"options\": [", " {", - " \"<shared\": \"network option specification>\"", + " <shared network option specification>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" @@ -36,8 +36,8 @@ " \"arguments\": {", " \"options\": [", " {", - " \"code\": \"<option code>\",", - " \"space\": \"<option space>\"", + " \"code\": <option code>,", + " \"space\": <option space>", " }", " ]", " }", diff --git a/src/share/api/remote-option6-pd-pool-del.json b/src/share/api/remote-option6-pd-pool-del.json index 83a3624a58..f0d2be1441 100644 --- a/src/share/api/remote-option6-pd-pool-del.json +++ b/src/share/api/remote-option6-pd-pool-del.json @@ -13,18 +13,18 @@ " \"arguments\": {", " \"pd-pools\": [", " {", - " \"prefix\": \"<pool prefix (address part)>\",", - " \"prefix-len\": \"<pool prefix (length part)>\"", + " \"prefix\": <pool prefix (address part)>,", + " \"prefix-len\": <pool prefix (length part)>", " }", " ],", " \"options\": [", " {", - " \"code\": \"<option code>\",", - " \"space\": \"<option space>\"", + " \"code\": <option code>,", + " \"space\": <option space>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" diff --git a/src/share/api/remote-option6-pd-pool-set.json b/src/share/api/remote-option6-pd-pool-set.json index 9afa088a9e..17d752e518 100644 --- a/src/share/api/remote-option6-pd-pool-set.json +++ b/src/share/api/remote-option6-pd-pool-set.json @@ -13,17 +13,17 @@ " \"arguments\": {", " \"pd-pools\": [", " {", - " \"prefix\": \"<pool prefix (address part)>\",", - " \"prefix-len\": \"<pool prefix (length part)>\"", + " \"prefix\": <pool prefix (address part)>,", + " \"prefix-len\": <pool prefix (length part)>", " }", " ],", " \"options\": [", " {", - " \"<prefix\": \"delegation pool option specification>\"", + " <prefix delegation pool option specification>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" @@ -37,8 +37,8 @@ " \"arguments\": {", " \"options\": [", " {", - " \"code\": \"<option code>\",", - " \"space\": \"<option space>\"", + " \"code\": <option code>,", + " \"space\": <option space>", " }", " ]", " }", diff --git a/src/share/api/remote-option6-pool-del.json b/src/share/api/remote-option6-pool-del.json index 01688b4ccc..1fafd833c9 100644 --- a/src/share/api/remote-option6-pool-del.json +++ b/src/share/api/remote-option6-pool-del.json @@ -13,17 +13,17 @@ " \"arguments\": {", " \"pools\": [", " {", - " \"pool\": \"<pool range or prefix>\"", + " \"pool\": <pool range or prefix>", " }", " ],", " \"options\": [", " {", - " \"code\": \"<option code>\",", - " \"space\": \"<option space>\"", + " \"code\": <option code>,", + " \"space\": <option space>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" diff --git a/src/share/api/remote-option6-pool-set.json b/src/share/api/remote-option6-pool-set.json index dc3d17c4cd..ae45e3e49c 100644 --- a/src/share/api/remote-option6-pool-set.json +++ b/src/share/api/remote-option6-pool-set.json @@ -13,16 +13,16 @@ " \"arguments\": {", " \"pools\": [", " {", - " \"pool\": \"<pool range or prefix>\"", + " \"pool\": <pool range or prefix>", " }", " ],", " \"options\": [", " {", - " \"<address\": \"pool option specification>\"", + " <address pool option specification>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" @@ -36,8 +36,8 @@ " \"arguments\": {", " \"options\": [", " {", - " \"code\": \"<option code>\",", - " \"space\": \"<option space>\"", + " \"code\": <option code>,", + " \"space\": <option space>", " }", " ]", " }", diff --git a/src/share/api/remote-option6-subnet-del.json b/src/share/api/remote-option6-subnet-del.json index fee7443a5c..ff24ed3482 100644 --- a/src/share/api/remote-option6-subnet-del.json +++ b/src/share/api/remote-option6-subnet-del.json @@ -13,17 +13,17 @@ " \"arguments\": {", " \"subnets\": [", " {", - " \"id\": \"<subnet identifier>\"", + " \"id\": <subnet identifier>", " }", " ],", " \"options\": [", " {", - " \"code\": \"<option code>\",", - " \"space\": \"<option space>\"", + " \"code\": <option code>,", + " \"space\": <option space>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" diff --git a/src/share/api/remote-option6-subnet-set.json b/src/share/api/remote-option6-subnet-set.json index 3ee3996077..d0097d69e5 100644 --- a/src/share/api/remote-option6-subnet-set.json +++ b/src/share/api/remote-option6-subnet-set.json @@ -13,16 +13,16 @@ " \"arguments\": {", " \"subnets\": [", " {", - " \"id\": \"<subnet identifier>\"", + " \"id\": <subnet identifier>", " }", " ],", " \"options\": [", " {", - " \"<subnet\": \"option specification>\"", + " <subnet option specification>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" @@ -36,8 +36,8 @@ " \"arguments\": {", " \"options\": [", " {", - " \"code\": \"<option code>\",", - " \"space\": \"<option space>\"", + " \"code\": <option code>,", + " \"space\": <option space>", " }", " ]", " }", diff --git a/src/share/api/remote-server4-del.json b/src/share/api/remote-server4-del.json index 22494fee9b..4f7718c90c 100644 --- a/src/share/api/remote-server4-del.json +++ b/src/share/api/remote-server4-del.json @@ -13,11 +13,11 @@ " \"arguments\": {", " \"servers\": [", " {", - " \"server-tag\": \"<server name>\"", + " \"server-tag\": <server name>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" diff --git a/src/share/api/remote-server4-get-all.json b/src/share/api/remote-server4-get-all.json index 42fa66ac7f..5555752e40 100644 --- a/src/share/api/remote-server4-get-all.json +++ b/src/share/api/remote-server4-get-all.json @@ -12,7 +12,7 @@ " \"command\": \"remote-server4-get-all\",", " \"arguments\": {", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" @@ -29,12 +29,12 @@ " \"arguments\": {", " \"servers\": [", " {", - " \"server-tag\": \"<first server tag>\",", - " \"description\": \"<first server description>\"", + " \"server-tag\": <first server tag>,", + " \"description\": <first server description>", " },", " {", - " \"server-tag\": \"<second server tag>\",", - " \"description\": \"<second server description>\"", + " \"server-tag\": <second server tag>,", + " \"description\": <second server description>", " }", " ],", " \"count\": 2", diff --git a/src/share/api/remote-server4-get.json b/src/share/api/remote-server4-get.json index 490e476ac6..c64860636f 100644 --- a/src/share/api/remote-server4-get.json +++ b/src/share/api/remote-server4-get.json @@ -13,11 +13,11 @@ " \"arguments\": {", " \"servers\": [", " {", - " \"server-tag\": \"<server tag>\"", + " \"server-tag\": <server tag>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" @@ -34,8 +34,8 @@ " \"arguments\": {", " \"servers\": [", " {", - " \"server-tag\": \"<server tag>\",", - " \"description\": \"<server description>\"", + " \"server-tag\": <server tag>,", + " \"description\": <server description>", " }", " ],", " \"count\": 1", diff --git a/src/share/api/remote-server4-set.json b/src/share/api/remote-server4-set.json index 5f6de46356..b63e38930a 100644 --- a/src/share/api/remote-server4-set.json +++ b/src/share/api/remote-server4-set.json @@ -13,12 +13,12 @@ " \"arguments\": {", " \"servers\": [", " {", - " \"server-tag\": \"<server tag>\",", - " \"description\": \"<server description>\"", + " \"server-tag\": <server tag>,", + " \"description\": <server description>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" @@ -32,8 +32,8 @@ " \"arguments\": {", " \"servers\": [", " {", - " \"server-tag\": \"<server tag>\",", - " \"description\": \"<server description>\"", + " \"server-tag\": <server tag>,", + " \"description\": <server description>", " }", " ]", " }", diff --git a/src/share/api/remote-server6-del.json b/src/share/api/remote-server6-del.json index 9647cc0e48..5ca04c2b43 100644 --- a/src/share/api/remote-server6-del.json +++ b/src/share/api/remote-server6-del.json @@ -13,11 +13,11 @@ " \"arguments\": {", " \"servers\": [", " {", - " \"server-tag\": \"<server name>\"", + " \"server-tag\": <server name>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" diff --git a/src/share/api/remote-server6-get-all.json b/src/share/api/remote-server6-get-all.json index ca75c19515..ab12139156 100644 --- a/src/share/api/remote-server6-get-all.json +++ b/src/share/api/remote-server6-get-all.json @@ -12,7 +12,7 @@ " \"command\": \"remote-server6-get-all\",", " \"arguments\": {", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" @@ -29,12 +29,12 @@ " \"arguments\": {", " \"servers\": [", " {", - " \"server-tag\": \"<first server tag>\",", - " \"description\": \"<first server description>\"", + " \"server-tag\": <first server tag>,", + " \"description\": <first server description>", " },", " {", - " \"server-tag\": \"<second server tag>\",", - " \"description\": \"<second server description>\"", + " \"server-tag\": <second server tag>,", + " \"description\": <second server description>", " }", " ],", " \"count\": 2", diff --git a/src/share/api/remote-server6-get.json b/src/share/api/remote-server6-get.json index 3a08aba396..1acbfd4fd5 100644 --- a/src/share/api/remote-server6-get.json +++ b/src/share/api/remote-server6-get.json @@ -13,11 +13,11 @@ " \"arguments\": {", " \"servers\": [", " {", - " \"server-tag\": \"<server tag>\"", + " \"server-tag\": <server tag>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" @@ -34,8 +34,8 @@ " \"arguments\": {", " \"servers\": [", " {", - " \"server-tag\": \"<server tag>\",", - " \"description\": \"<server description>\"", + " \"server-tag\": <server tag>,", + " \"description\": <server description>", " }", " ],", " \"count\": 1", diff --git a/src/share/api/remote-server6-set.json b/src/share/api/remote-server6-set.json index 5586a57946..211a4dc918 100644 --- a/src/share/api/remote-server6-set.json +++ b/src/share/api/remote-server6-set.json @@ -13,12 +13,12 @@ " \"arguments\": {", " \"servers\": [", " {", - " \"server-tag\": \"<server tag>\",", - " \"description\": \"<server description>\"", + " \"server-tag\": <server tag>,", + " \"description\": <server description>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" @@ -32,8 +32,8 @@ " \"arguments\": {", " \"servers\": [", " {", - " \"server-tag\": \"<server tag>\",", - " \"description\": \"<server description>\"", + " \"server-tag\": <server tag>,", + " \"description\": <server description>", " }", " ]", " }", diff --git a/src/share/api/remote-subnet4-del-by-id.json b/src/share/api/remote-subnet4-del-by-id.json index a708640f5e..4ccf7f8662 100644 --- a/src/share/api/remote-subnet4-del-by-id.json +++ b/src/share/api/remote-subnet4-del-by-id.json @@ -13,11 +13,11 @@ " \"arguments\": {", " \"subnets\": [", " {", - " \"id\": \"<subnet identifier>\"", + " \"id\": <subnet identifier>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" diff --git a/src/share/api/remote-subnet4-del-by-prefix.json b/src/share/api/remote-subnet4-del-by-prefix.json index fc27e57680..7d7b1a384c 100644 --- a/src/share/api/remote-subnet4-del-by-prefix.json +++ b/src/share/api/remote-subnet4-del-by-prefix.json @@ -13,11 +13,11 @@ " \"arguments\": {", " \"subnets\": [", " {", - " \"subnet\": \"<subnet prefix>\"", + " \"subnet\": <subnet prefix>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" diff --git a/src/share/api/remote-subnet4-get-by-id.json b/src/share/api/remote-subnet4-get-by-id.json index c8c841165a..e23bbe15e1 100644 --- a/src/share/api/remote-subnet4-get-by-id.json +++ b/src/share/api/remote-subnet4-get-by-id.json @@ -12,10 +12,10 @@ " \"command\": \"remote-subnet4-get-by-id\",", " \"arguments\": {", " \"subnets\": [ {", - " \"id\": \"<subnet identifier>\"", + " \"id\": <subnet identifier>", " } ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" @@ -31,13 +31,13 @@ " \"text\": \"IPv4 subnet found.\",", " \"arguments\": {", " \"subnets\": [ {", - " \"id\": \"<subnet identifier>\",", - " \"subnet\": \"<subnet prefix>\",", - " \"shared-network-name\": \"<shared network name or null>\",", + " \"id\": <subnet identifier>,", + " \"subnet\": <subnet prefix>,", + " \"shared-network-name\": <shared network name or null>,", " \"metadata\": {", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " },", - " \"<the\": \"rest of the subnet specification here>\"", + " <the rest of the subnet specification here>", " } ],", " \"count\": 1", " }", diff --git a/src/share/api/remote-subnet4-get-by-prefix.json b/src/share/api/remote-subnet4-get-by-prefix.json index c8b9e12cae..d973412344 100644 --- a/src/share/api/remote-subnet4-get-by-prefix.json +++ b/src/share/api/remote-subnet4-get-by-prefix.json @@ -12,10 +12,10 @@ " \"command\": \"remote-subnet4-get-by-prefix\",", " \"arguments\": {", " \"subnets\": [ {", - " \"subnet\": \"<subnet prefix>\"", + " \"subnet\": <subnet prefix>", " } ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" @@ -32,13 +32,13 @@ " \"arguments\": {", " \"subnets\": [", " {", - " \"id\": \"<subnet identifier>\",", - " \"subnet\": \"<subnet prefix>\",", - " \"shared-network-name\": \"<shared network name or null>\",", + " \"id\": <subnet identifier>,", + " \"subnet\": <subnet prefix>,", + " \"shared-network-name\": <shared network name or null>,", " \"metadata\": {", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " },", - " \"<the\": \"rest of the subnet specification here>\"", + " <the rest of the subnet specification here>", " }", " ],", " \"count\": 1", diff --git a/src/share/api/remote-subnet4-list.json b/src/share/api/remote-subnet4-list.json index 154501b5b1..d4f6902169 100644 --- a/src/share/api/remote-subnet4-list.json +++ b/src/share/api/remote-subnet4-list.json @@ -12,9 +12,9 @@ " \"command\": \"remote-subnet4-list\",", " \"arguments\": {", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " }", "}" ], @@ -30,19 +30,19 @@ " \"arguments\": {", " \"subnets\": [", " {", - " \"id\": \"<first subnet identifier>\",", - " \"subnet\": \"<first subnet prefix>\",", - " \"shared-network-name\": \"<shared network name or null>\",", + " \"id\": <first subnet identifier>,", + " \"subnet\": <first subnet prefix>,", + " \"shared-network-name\": <shared network name or null>,", " \"metadata\": {", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " }", " },", " {", - " \"id\": \"<second subnet identifier>\",", - " \"subnet\": \"<second subnet prefix>\",", - " \"shared-network-name\": \"<shared network name or null>\",", + " \"id\": <second subnet identifier>,", + " \"subnet\": <second subnet prefix>,", + " \"shared-network-name\": <shared network name or null>,", " \"metadata\": {", - " \"server-tags\": [ \"<first server tag>\" ]", + " \"server-tags\": [ <first server tag>, ... ]", " }", " }", " ],", diff --git a/src/share/api/remote-subnet4-set.json b/src/share/api/remote-subnet4-set.json index 99b693b473..772e13e85c 100644 --- a/src/share/api/remote-subnet4-set.json +++ b/src/share/api/remote-subnet4-set.json @@ -13,16 +13,16 @@ " \"arguments\": {", " \"subnets\": [", " {", - " \"id\": \"<subnet identifier>\",", - " \"subnet\": \"<subnet prefix>\",", - " \"shared-network-name\": \"<shared network name or null>\",", - " \"<the\": \"rest of the subnet specification here>\"", + " \"id\": <subnet identifier>,", + " \"subnet\": <subnet prefix>,", + " \"shared-network-name\": <shared network name or null>,", + " <the rest of the subnet specification here>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " }", "}" ], @@ -33,8 +33,8 @@ " \"result\": 0,", " \"text\": \"IPv4 subnet successfully set.\",", " \"arguments\": {", - " \"id\": \"<subnet identifier>\",", - " \"subnet\": \"<subnet prefix>\"", + " \"id\": <subnet identifier>,", + " \"subnet\": <subnet prefix>", " }", "}" ], diff --git a/src/share/api/remote-subnet6-del-by-id.json b/src/share/api/remote-subnet6-del-by-id.json index 465b54376e..291cdfd985 100644 --- a/src/share/api/remote-subnet6-del-by-id.json +++ b/src/share/api/remote-subnet6-del-by-id.json @@ -13,11 +13,11 @@ " \"arguments\": {", " \"subnets\": [", " {", - " \"id\": \"<subnet identifier>\"", + " \"id\": <subnet identifier>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" diff --git a/src/share/api/remote-subnet6-del-by-prefix.json b/src/share/api/remote-subnet6-del-by-prefix.json index e11ab9686e..5dff846baa 100644 --- a/src/share/api/remote-subnet6-del-by-prefix.json +++ b/src/share/api/remote-subnet6-del-by-prefix.json @@ -13,11 +13,11 @@ " \"arguments\": {", " \"subnets\": [", " {", - " \"subnet\": \"<subnet prefix>\"", + " \"subnet\": <subnet prefix>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" diff --git a/src/share/api/remote-subnet6-get-by-id.json b/src/share/api/remote-subnet6-get-by-id.json index 15aceeb69c..b1dd25f088 100644 --- a/src/share/api/remote-subnet6-get-by-id.json +++ b/src/share/api/remote-subnet6-get-by-id.json @@ -13,11 +13,11 @@ " \"arguments\": {", " \"subnets\": [", " {", - " \"id\": \"<subnet identifier>\"", + " \"id\": <subnet identifier>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" @@ -34,13 +34,13 @@ " \"arguments\": {", " \"subnets\": [", " {", - " \"id\": \"<subnet identifier>\",", - " \"subnet\": \"<subnet prefix>\",", - " \"shared-network-name\": \"<shared network name or null>\",", + " \"id\": <subnet identifier>,", + " \"subnet\": <subnet prefix>,", + " \"shared-network-name\": <shared network name or null>,", " \"metadata\": {", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " },", - " \"<the\": \"rest of the subnet specification here>\"", + " <the rest of the subnet specification here>", " }", " ],", " \"count\": 1", diff --git a/src/share/api/remote-subnet6-get-by-prefix.json b/src/share/api/remote-subnet6-get-by-prefix.json index f7ec7654c8..249f9bb948 100644 --- a/src/share/api/remote-subnet6-get-by-prefix.json +++ b/src/share/api/remote-subnet6-get-by-prefix.json @@ -13,11 +13,11 @@ " \"arguments\": {", " \"subnets\": [", " {", - " \"subnet\": \"<subnet prefix>\"", + " \"subnet\": <subnet prefix>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " }", " }", "}" @@ -33,13 +33,13 @@ " \"text\": \"IPv6 subnet found.\",", " \"arguments\": {", " \"subnets\": [ {", - " \"id\": \"<subnet identifier>\",", - " \"subnet\": \"<subnet prefix>\",", - " \"shared-network-name\": \"<shared network name or null>\",", + " \"id\": <subnet identifier>,", + " \"subnet\": <subnet prefix>,", + " \"shared-network-name\": <shared network name or null>,", " \"metadata\": {", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " },", - " \"<the\": \"rest of the subnet specification here>\"", + " <the rest of the subnet specification here>", " } ],", " \"count\": 1", " }", diff --git a/src/share/api/remote-subnet6-list.json b/src/share/api/remote-subnet6-list.json index d993542442..72318ecc5c 100644 --- a/src/share/api/remote-subnet6-list.json +++ b/src/share/api/remote-subnet6-list.json @@ -12,9 +12,9 @@ " \"command\": \"remote-subnet6-list\",", " \"arguments\": {", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " }", "}" ], @@ -30,19 +30,19 @@ " \"arguments\": {", " \"subnets\": [", " {", - " \"id\": \"<first subnet identifier>\",", - " \"subnet\": \"<first subnet prefix>\",", - " \"shared-network-name\": \"<shared network name or null>\",", + " \"id\": <first subnet identifier>,", + " \"subnet\": <first subnet prefix>,", + " \"shared-network-name\": <shared network name or null>,", " \"metadata\": {", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " }", " },", " {", - " \"id\": \"<second subnet identifier>\",", - " \"subnet\": \"<second subnet prefix>\",", - " \"shared-network-name\": \"<shared network name or null>\",", + " \"id\": <second subnet identifier>,", + " \"subnet\": <second subnet prefix>,", + " \"shared-network-name\": <shared network name or null>,", " \"metadata\": {", - " \"server-tags\": [ \"<first server tag>\" ]", + " \"server-tags\": [ <first server tag>, ... ]", " }", " }", " ],", diff --git a/src/share/api/remote-subnet6-set.json b/src/share/api/remote-subnet6-set.json index 06f2d04640..a746926e9e 100644 --- a/src/share/api/remote-subnet6-set.json +++ b/src/share/api/remote-subnet6-set.json @@ -13,16 +13,16 @@ " \"arguments\": {", " \"subnets\": [", " {", - " \"id\": \"<subnet identifier>\",", - " \"subnet\": \"<subnet prefix>\",", - " \"shared-network-name\": \"<shared network name or null>\",", - " \"<the\": \"rest of the subnet specification here>\"", + " \"id\": <subnet identifier>,", + " \"subnet\": <subnet prefix>,", + " \"shared-network-name\": <shared network name or null>,", + " <the rest of the subnet specification here>", " }", " ],", " \"remote\": {", - " \"<specification\": \"of the database to connect to>\"", + " <specification of the database to connect to>", " },", - " \"server-tags\": [ \"<first server tag>, <second server tag>\" ]", + " \"server-tags\": [ <first server tag>, <second server tag>, ... ]", " }", "}" ], @@ -33,8 +33,8 @@ " \"result\": 0,", " \"text\": \"IPv6 subnet successfully set.\",", " \"arguments\": {", - " \"id\": \"<subnet identifier>\",", - " \"subnet\": \"<subnet prefix>\"", + " \"id\": <subnet identifier>,", + " \"subnet\": <subnet prefix>", " }", "}" ], diff --git a/src/share/api/reservation-add.json b/src/share/api/reservation-add.json index 4109ca5d01..d771725613 100644 --- a/src/share/api/reservation-add.json +++ b/src/share/api/reservation-add.json @@ -12,22 +12,22 @@ " \"command\": \"reservation-add\",", " \"arguments\": {", " \"reservation\": {", - " \"boot-file-name\": \"<string>\",", - " \"client-id\": \"<string>\",", - " \"circuit-id\": \"<string>\",", - " \"duid\": \"<string>\",", - " \"flex-id\": \"<string>\",", - " \"ip-address\": \"<string (IPv4 address)>\",", - " \"ip-addresses\": [ \"<comma-separated strings>\" ],", - " \"hw-address\": \"<string>\",", - " \"hostname\": \"<string>\",", - " \"next-server\": \"<string (IPv4 address)>\",", - " \"option-data\": [ \"<comma-separated structures defining options>\" ],", - " \"prefixes\": [ \"<comma-separated IPv6 prefixes>\" ],", - " \"client-classes\": [ \"<comma-separated strings>\" ],", - " \"server-hostname\": \"<string>\",", - " \"subnet-id\": \"<integer>\",", - " \"user-context\": \"<any valid JSON>\"", + " \"boot-file-name\": <string>,", + " \"client-id\": <string>,", + " \"circuit-id\": <string>,", + " \"duid\": <string>,", + " \"flex-id\": <string>,", + " \"ip-address\": <string (IPv4 address)>,", + " \"ip-addresses\": [ <comma-separated strings> ],", + " \"hw-address\": <string>,", + " \"hostname\": <string>,", + " \"next-server\": <string (IPv4 address)>,", + " \"option-data\": [ <comma-separated structures defining options> ],", + " \"prefixes\": [ <comma-separated IPv6 prefixes> ],", + " \"client-classes\": [ <comma-separated strings> ],", + " \"server-hostname\": <string>,", + " \"subnet-id\": <integer>,", + " \"user-context\": <any valid JSON>", " }", " }", "}" @@ -38,8 +38,8 @@ "resp-syntax": [ "", "{", - " \"result\": \"<integer>\",", - " \"text\": \"<string>\"", + " \"result\": <integer>,", + " \"text\": <string>", "}" ], "support": [ diff --git a/src/share/api/reservation-del.json b/src/share/api/reservation-del.json index 95db1fb2e9..61ec8d7878 100644 --- a/src/share/api/reservation-del.json +++ b/src/share/api/reservation-del.json @@ -11,10 +11,10 @@ "{", " \"command\": \"reservation-del\",", " \"arguments\": {", - " \"subnet-id\": \"<integer>\",", - " \"ip-address\": \"<string>\",", - " \"identifier-type\": \"<one of 'hw-address', 'duid', 'circuit-id', 'client-id' and 'flex-id'>\",", - " \"identifier\": \"<string>\"", + " \"subnet-id\": <integer>,", + " \"ip-address\": <string>,", + " \"identifier-type\": <one of 'hw-address', 'duid', 'circuit-id', 'client-id' and 'flex-id'>,", + " \"identifier\": <string>", " }", "}" ], diff --git a/src/share/api/reservation-get-all.json b/src/share/api/reservation-get-all.json index 10c5ed15aa..5e1eeb594c 100644 --- a/src/share/api/reservation-get-all.json +++ b/src/share/api/reservation-get-all.json @@ -8,7 +8,7 @@ "{", " \"command\": \"reservation-get-all\",", " \"arguments\": {", - " \"subnet-id\": \"<integer>\"", + " \"subnet-id\": <integer>", " }", "}" ], diff --git a/src/share/api/reservation-get-by-hostname.json b/src/share/api/reservation-get-by-hostname.json index 4ed5453ef4..06d0e5cb94 100644 --- a/src/share/api/reservation-get-by-hostname.json +++ b/src/share/api/reservation-get-by-hostname.json @@ -8,8 +8,8 @@ "{", " \"command\": \"reservation-get-by-hostname\",", " \"arguments\": {", - " \"hostname\": \"<hostname>\",", - " \"subnet-id\": \"<integer>\"", + " \"hostname\": <hostname>,", + " \"subnet-id\": <integer>", " }", "}" ], diff --git a/src/share/api/reservation-get-by-id.json b/src/share/api/reservation-get-by-id.json index bc7f4971a7..59958df62e 100644 --- a/src/share/api/reservation-get-by-id.json +++ b/src/share/api/reservation-get-by-id.json @@ -8,8 +8,8 @@ "{", " \"command\": \"reservation-get-by-id\",", " \"arguments\": {", - " \"identifier-type\": \"<one of 'hw-address', 'duid', 'circuit-id', 'client-id' and 'flex-id'>\",", - " \"identifier\": \"<string>\"", + " \"identifier-type\": <one of 'hw-address', 'duid', 'circuit-id', 'client-id' and 'flex-id'>,", + " \"identifier\": <string>", " }", "}" ], diff --git a/src/share/api/reservation-get-page.json b/src/share/api/reservation-get-page.json index 4ee3db908b..6be2b52ff1 100644 --- a/src/share/api/reservation-get-page.json +++ b/src/share/api/reservation-get-page.json @@ -11,10 +11,10 @@ "{", " \"command\": \"reservation-get-page\",", " \"arguments\": {", - " \"subnet-id\": \"<integer>\",", - " \"limit\": \"<integer>\",", - " \"source-index\": \"<integer>\",", - " \"from\": \"<integer>\"", + " \"subnet-id\": <integer>,", + " \"limit\": <integer>,", + " \"source-index\": <integer>,", + " \"from\": <integer>", " }", "}" ], diff --git a/src/share/api/reservation-get.json b/src/share/api/reservation-get.json index 7930962227..16b3f194c7 100644 --- a/src/share/api/reservation-get.json +++ b/src/share/api/reservation-get.json @@ -11,9 +11,9 @@ "{", " \"command\": \"reservation-get\",", " \"arguments\": {", - " \"subnet-id\": \"<integer>\",", - " \"identifier-type\": \"<one of 'hw-address', 'duid', 'circuit-id', 'client-id' and 'flex-id'>\",", - " \"identifier\": \"<string>\"", + " \"subnet-id\": <integer>,", + " \"identifier-type\": <one of 'hw-address', 'duid', 'circuit-id', 'client-id' and 'flex-id'>,", + " \"identifier\": <string>", " }", "}" ], @@ -24,26 +24,26 @@ ], "resp-syntax": [ "{", - " \"result\": \"<integer>\",", - " \"text\": \"<string>\",", + " \"result\": <integer>,", + " \"text\": <string>,", " \"arguments\": {", - " \"boot-file-name\": \"<string>\",", - " \"comment\": \"<string>\",", - " \"client-id\": \"<string>\",", - " \"circuit-id\": \"<string>\",", - " \"duid\": \"<string>\",", - " \"flex-id\": \"<string>\",", - " \"ip-address\": \"<string (IPv4 address)>\",", - " \"ip-addresses\": [ \"<comma-separated strings>\" ],", - " \"hw-address\": \"<string>\",", - " \"hostname\": \"<string>\",", - " \"next-server\": \"<string (IPv4 address)>\",", - " \"option-data\": [ \"<comma-separated structures defining options>\" ],", - " \"prefixes\": [ \"<comma-separated IPv6 prefixes>\" ],", - " \"client-classes\": [ \"<comma-separated strings>\" ],", - " \"server-hostname\": \"<string>\",", - " \"subnet-id\": \"<integer>\",", - " \"user-context\": \"<any valid JSON>\"", + " \"boot-file-name\": <string>,", + " \"comment\": <string>,", + " \"client-id\": <string>,", + " \"circuit-id\": <string>,", + " \"duid\": <string>,", + " \"flex-id\": <string>,", + " \"ip-address\": <string (IPv4 address)>,", + " \"ip-addresses\": [ <comma-separated strings> ],", + " \"hw-address\": <string>,", + " \"hostname\": <string>,", + " \"next-server\": <string (IPv4 address)>,", + " \"option-data\": [ <comma-separated structures defining options> ],", + " \"prefixes\": [ <comma-separated IPv6 prefixes> ],", + " \"client-classes\": [ <comma-separated strings> ],", + " \"server-hostname\": <string>,", + " \"subnet-id\": <integer>,", + " \"user-context\": <any valid JSON>", " }", "}" ], diff --git a/src/share/api/reservation-update.json b/src/share/api/reservation-update.json index 2628592777..7af996b6fb 100644 --- a/src/share/api/reservation-update.json +++ b/src/share/api/reservation-update.json @@ -12,22 +12,22 @@ " \"command\": \"reservation-update\",", " \"arguments\": {", " \"reservation\": {", - " \"boot-file-name\": \"<string>\",", - " \"client-id\": \"<string>\",", - " \"circuit-id\": \"<string>\",", - " \"duid\": \"<string>\",", - " \"flex-id\": \"<string>\",", - " \"ip-address\": \"<string (IPv4 address)>\",", - " \"ip-addresses\": [ \"<comma-separated strings>\" ],", - " \"hw-address\": \"<string>\",", - " \"hostname\": \"<string>\",", - " \"next-server\": \"<string (IPv4 address)>\",", - " \"option-data\": [ \"<comma-separated structures defining options>\" ],", - " \"prefixes\": [ \"<comma-separated IPv6 prefixes>\" ],", - " \"client-classes\": [ \"<comma-separated strings>\" ],", - " \"server-hostname\": \"<string>\",", - " \"subnet-id\": \"<integer>\",", - " \"user-context\": \"<any valid JSON>\"", + " \"boot-file-name\": <string>,", + " \"client-id\": <string>,", + " \"circuit-id\": <string>,", + " \"duid\": <string>,", + " \"flex-id\": <string>,", + " \"ip-address\": <string (IPv4 address)>,", + " \"ip-addresses\": [ <comma-separated strings> ],", + " \"hw-address\": <string>,", + " \"hostname\": <string>,", + " \"next-server\": <string (IPv4 address)>,", + " \"option-data\": [ <comma-separated structures defining options> ],", + " \"prefixes\": [ <comma-separated IPv6 prefixes> ],", + " \"client-classes\": [ <comma-separated strings> ],", + " \"server-hostname\": <string>,", + " \"subnet-id\": <integer>,", + " \"user-context\": <any valid JSON>", " }", " }", "}" @@ -38,8 +38,8 @@ "resp-syntax": [ "", "{", - " \"result\": \"<integer>\",", - " \"text\": \"<string>\"", + " \"result\": <integer>,", + " \"text\": <string>", "}" ], "support": [ diff --git a/src/share/api/status-get.json b/src/share/api/status-get.json index deb4f458fc..8e107a71d5 100644 --- a/src/share/api/status-get.json +++ b/src/share/api/status-get.json @@ -17,26 +17,26 @@ ], "resp-syntax": [ "{", - " \"result\": \"<integer>\",", + " \"result\": <integer>,", " \"arguments\": {", - " \"pid\": \"<integer>\",", - " \"uptime\": \"<uptime in seconds>\",", - " \"reload\": \"<time since reload in seconds>\",", + " \"pid\": <integer>,", + " \"uptime\": <uptime in seconds>,", + " \"reload\": <time since reload in seconds>,", " \"high-availability\": [", " {", - " \"ha-mode\": \"<HA mode configured for this relationship>\",", + " \"ha-mode\": <HA mode configured for this relationship>,", " \"ha-servers\": {", " \"local\": {", - " \"role\": \"<role of this server as in the configuration file>\",", - " \"scopes\": \"<list of scope names served by this server>\",", - " \"state\": \"<HA state name of the server receiving the command>\"", + " \"role\": <role of this server as in the configuration file>,", + " \"scopes\": <list of scope names served by this server>,", + " \"state\": <HA state name of the server receiving the command>", " },", " \"remote\": {", - " \"age\": \"<the age of the remote status in seconds>\",", - " \"in-touch\": \"<indicates if this server communicated with remote>\",", - " \"last-scopes\": \"<list of scopes served by partner>\",", - " \"last-state\": \"<HA state name of the partner>\",", - " \"role\": \"<partner role>\"", + " \"age\": <the age of the remote status in seconds>,", + " \"in-touch\": <indicates if this server communicated with remote>,", + " \"last-scopes\": <list of scopes served by partner>,", + " \"last-state\": <HA state name of the partner>,", + " \"role\": <partner role>", " }", " }", " }", @@ -46,10 +46,8 @@ " \"packet-queue-size\": 64,", " \"packet-queue-statistics\": [ 1.2, 2.3, 3.4 ],", " \"sockets\": {", - " \"errors\": [", - " \"<error received during the last attempt to open all sockets>\"", - " ],", - " \"status\": \"<ready, retrying, or failed>\"", + " \"errors\": [ <error received during the last attempt to open all sockets> ],", + " \"status\": <ready, retrying, or failed>", " }", " }", "}" diff --git a/src/share/api/subnet4-add.json b/src/share/api/subnet4-add.json index cfb1dc67af..7b1ea8b0b5 100644 --- a/src/share/api/subnet4-add.json +++ b/src/share/api/subnet4-add.json @@ -11,7 +11,7 @@ " \"subnet4\": [ {", " \"id\": 123,", " \"subnet\": \"10.20.30.0/24\",", - " \"<other\": \"properties>\"", + " ...", " } ]", " }", "}" diff --git a/src/share/api/subnet4-delta-add.json b/src/share/api/subnet4-delta-add.json index 575b569076..fb66313cc9 100644 --- a/src/share/api/subnet4-delta-add.json +++ b/src/share/api/subnet4-delta-add.json @@ -11,7 +11,7 @@ " \"subnet4\": [ {", " \"id\": 123,", " \"subnet\": \"10.20.30.0/24\",", - " \"<other\": \"properties>\"", + " ...", " } ]", " }", "}" diff --git a/src/share/api/subnet4-delta-del.json b/src/share/api/subnet4-delta-del.json index 0653c98645..16c60d77c1 100644 --- a/src/share/api/subnet4-delta-del.json +++ b/src/share/api/subnet4-delta-del.json @@ -11,7 +11,7 @@ " \"subnet4\": [ {", " \"id\": 123,", " \"subnet\": \"10.20.30.0/24\",", - " \"<other\": \"properties>\"", + " ...", " } ]", " }", "}" diff --git a/src/share/api/subnet4-get.json b/src/share/api/subnet4-get.json index bddb2c0ddf..97d24cce8a 100644 --- a/src/share/api/subnet4-get.json +++ b/src/share/api/subnet4-get.json @@ -24,10 +24,10 @@ " {", " \"subnet\": \"10.0.0.0/8\",", " \"id\": 1,", - " \"option-data\": [", - " \"<other properties>\"", - " ],", - " \"<other\": \"properties>\"", + " \"option-data\": [{", + " ...", + " }],", + " ...", " }", " ]", " }", diff --git a/src/share/api/subnet4-update.json b/src/share/api/subnet4-update.json index 66e7a9a228..f131b9e815 100644 --- a/src/share/api/subnet4-update.json +++ b/src/share/api/subnet4-update.json @@ -11,7 +11,7 @@ " \"subnet4\": [ {", " \"id\": 123,", " \"subnet\": \"10.20.30.0/24\",", - " \"<other\": \"properties>\"", + " ...", " } ]", " }", "}" diff --git a/src/share/api/subnet6-add.json b/src/share/api/subnet6-add.json index 6ff7c16a89..77418d55cd 100644 --- a/src/share/api/subnet6-add.json +++ b/src/share/api/subnet6-add.json @@ -11,7 +11,7 @@ " \"subnet6\": [ {", " \"id\": 234,", " \"subnet\": \"2001:db8:1::/64\",", - " \"<other\": \"properties>\"", + " ...", " } ]", " }", "}" diff --git a/src/share/api/subnet6-delta-add.json b/src/share/api/subnet6-delta-add.json index e0d3c41666..0b48c995db 100644 --- a/src/share/api/subnet6-delta-add.json +++ b/src/share/api/subnet6-delta-add.json @@ -11,7 +11,7 @@ " \"subnet6\": [ {", " \"id\": 234,", " \"subnet\": \"2001:db8:1::/64\",", - " \"<other\": \"properties>\"", + " ...", " } ]", " }", "}" diff --git a/src/share/api/subnet6-delta-del.json b/src/share/api/subnet6-delta-del.json index 633f48ff48..39118bf2f6 100644 --- a/src/share/api/subnet6-delta-del.json +++ b/src/share/api/subnet6-delta-del.json @@ -11,7 +11,7 @@ " \"subnet6\": [ {", " \"id\": 234,", " \"subnet\": \"2001:db8:1::/64\",", - " \"<other\": \"properties>\"", + " ...", " } ]", " }", "}" diff --git a/src/share/api/subnet6-get.json b/src/share/api/subnet6-get.json index 101541eb39..f7ac2efd10 100644 --- a/src/share/api/subnet6-get.json +++ b/src/share/api/subnet6-get.json @@ -24,10 +24,10 @@ " {", " \"subnet\": \"2001:db8:1::/64\",", " \"id\": 1,", - " \"option-data\": [", - " \"<other properties>\"", - " ],", - " \"<other\": \"properties>\"", + " \"option-data\": [{", + " ...", + " }],", + " ...", " }", " ]", " }", diff --git a/src/share/api/subnet6-update.json b/src/share/api/subnet6-update.json index fa022e9257..3d5725da98 100644 --- a/src/share/api/subnet6-update.json +++ b/src/share/api/subnet6-update.json @@ -11,7 +11,7 @@ " \"subnet6\": [ {", " \"id\": 234,", " \"subnet\": \"2001:db8:1::/64\",", - " \"<other\": \"properties>\"", + " ...", " } ]", " }", "}" diff --git a/tools/check-for-json-errors-in-doc.sh b/tools/check-for-json-errors-in-doc.sh index 19fad3d279..91704b877d 100755 --- a/tools/check-for-json-errors-in-doc.sh +++ b/tools/check-for-json-errors-in-doc.sh @@ -5,48 +5,83 @@ for file in `find ./ | grep -v "\.git" | grep -v "_build" | grep -v "\/man\/" | comment=0 line_num=0 echo "processing: $file" - while read line; do + while IFS= read line; do line_num=$((line_num+1)) - if [ $comment -eq 0 -a $json -eq 0 -a `echo "$line" | grep -e "^\[A-Za-z]+" | wc -l` -eq 1 ]; then + if [ $comment -eq 0 -a $json -eq 0 -a `echo "$line" | grep -e "^[A-Za-z]+\|^\s*\\\`" | wc -l` -eq 1 ]; then + # ignore line if it starts with 'A-Za-z' or spaces followed by '`' continue - elif [ $comment -eq 0 -a `echo "$line" | grep -e "\/\*" | grep -v -e "\*\/" | wc -l` -eq 1 ]; then + elif [ $comment -eq 0 -a `echo "$line" | grep -e "\/\*" | grep -v -e "\*\/" | wc -l` -eq 1 ]; then + # if the line contains /* and it does not contain */ on the same line comment=1 echo "" >> $work_file continue - elif [ $comment -eq 1 -a `echo "$line" | grep "\*\/" | wc -l` -eq 1 ]; then + elif [ $comment -eq 1 -a `echo "$line" | grep "\*\/" | wc -l` -eq 1 ]; then + # if the line contains */ comment=0 echo "" >> $work_file continue elif [ $comment -eq 0 -a $json -eq 0 -a `echo "$line" | grep "^\s*{\|^\s*\".*{" | grep -v "}" | grep -v "key\|pre" | wc -l` -eq 1 ]; then + # if this is not a commend and the line starts with spaces followed by '{' or by '"' followed by "{" + # ignore dns config: + # key "key.four.example.com." { + # algorithm hmac-sha224; + # secret "bZEG7Ow8OgAUPfLWV3aAUQ=="; + # }; + # ignore detailed html: + # .. raw:: html + # <details><summary>Expand here!</summary> + # <pre>{ + # ... + # }</pre> + # </details><br> json=1 # ignore any map name before top level map line=`echo "$line" | sed "s/.*{/{/g"` echo "" > $work_file - elif [ $comment -eq 0 -a $json -eq 1 -a `echo "$line" | grep -e "^\s*[A-Za-z]" | wc -l` -eq 1 ]; then + elif [ $comment -eq 0 -a $json -eq 1 -a `echo "$line" | grep -e "^\s*[A-Za-z]\|^\s*\\\`" | wc -l` -eq 1 ]; then + # if the line is not a comment and the line starts with spaces followed by 'A-Za-z' or followed by "`" and the parser is processing a json structure json=0 cat $work_file | jq . > /dev/null if [ $? -ne 0 ]; then + # if the jq tool returned error echo "file $file contains invalid JSON near line $line_num" echo "===start of JSON block===" cat $work_file echo "====end of JSON block====" fi fi - if [ $comment -eq 0 -a $json -eq 1 ]; then + if [ $comment -eq 0 -a $json -eq 1 ]; then if [ `echo "$line" | grep -e "^\s*\.\.\s" | wc -l` -eq 1 ]; then echo "" >> $work_file else + # if file is .json the following replace in line are done: + # 1. delete everything after '#' + # 2. delete everything after // + # 3. ignore <?include?> + # 4. replace all '[ <DATA> ]' with '[ "<DATA>"]' where DATA contains: '-' and 'A-Za-z0-9' and ' ' + # 5. replace all ' <DATA>:' with ' "<DATA>":' + # 6. replace all ': <DATA>' with ': "<DATA>"' + # 7. replace ' ...' with ' "placeholder": "value" + # 8. replace ', ... ' with ' ' + # 9. replace ' <DATA>' with ' "placeholder": "value"' + # 10. replace ' <DATA>' with ' "placeholder"' if [ `echo "$file" | grep "\.json" | wc -l` -eq 0 ]; then - echo "$line" | cut -d "#" -f 1 | sed "s/\.\.\./\"placeholder\": 0/g" | sed "s/\/\/ .*//g" | sed "s/<?.*?>//g" >> $work_file + echo "$line" | cut -d "#" -f 1 | sed "s/\/\/ .*//g" | sed "s/<?.*?>//g" | sed "s/\[ <\([-A-Za-z0-9 ]*\)> \]/\[ \"<\1>\" \]/g" | sed "s/ <\(.*\)>:/ \"<\1>\":/g" | sed "s/: <\(.*\)>/: \"<\1>\"/g" | sed "s/ \.\.\./ \"placeholder\": \"value\"/g" | sed "s/, \.\.\. / /g" | sed "s/ <\(.*\)>/ \"placeholder\": \"value\"/g" | sed "s/ <\(.*\)>/ \"placeholder\"/g" >> $work_file else + # if file is .rst the following replace in line are done: + # 1. delete everything after '#' + # 2. delete everything after // + # 3. ignore <?include?> echo "$line" | cut -d "#" -f 1 | sed "s/\/\/ .*//g" | sed "s/<?.*?>//g" >> $work_file fi fi fi done <<< $(cat $file | sed ':a;N;$!ba;s/,\s*\n\s*\.\.\.//g' | sed 's/\\\"/\\\\\"/g' | sed 's/\\\\,/\\\\\\\\,/g') if [ $comment -eq 0 -a $json -eq 1 ]; then + # if the file ended but the parser is processing a json structure cat $work_file | jq . > /dev/null if [ $? -ne 0 ]; then + # if the jq tool returned error echo "file $file contains invalid JSON near line $line_num" echo "===start of JSON block===" cat $work_file |