[#3961] Updated API files

modified:   doc/sphinx/arm/hooks-cb-cmds.rst
modified:   src/share/api/remote-option-def4-del.json
modified:   src/share/api/remote-option-def6-del.json

diff --git a/doc/sphinx/arm/hooks-cb-cmds.rst b/doc/sphinx/arm/hooks-cb-cmds.rst
index 216f12fa5571e0b6e4b3ea6091ffe8659e2cae14..1bcd06da9bdbeaf8b9841f80545cbfe1eab527ff 100644 (file)
--- a/doc/sphinx/arm/hooks-cb-cmds.rst
+++ b/doc/sphinx/arm/hooks-cb-cmds.rst
@@ -998,8 +998,8 @@ contain exactly one tag and cannot include the ``null`` value.
 As of Kea 3.1.2, before deleting an option definition, the server will first
 check if there are any options specified that depend upon that defintion. If
 so the delete command will be rejected with an error message explaining why.
-This default behavior may be overridden by ihcluding an optional ``force``
-parameter as shown below:
+This default behavior may be overridden by setting the optional ``force``
+parameter to true as shown below:
 
 .. code-block:: json
 

diff --git a/src/share/api/remote-option-def4-del.json b/src/share/api/remote-option-def4-del.json
index 9c8efca6b083ff2a89d1b9adddf70b01bcc2e6d4..a2c497266d4cf81635ff67ece692b767d13ce518 100644 (file)
--- a/src/share/api/remote-option-def4-del.json
+++ b/src/share/api/remote-option-def4-del.json
@@ -5,7 +5,7 @@
         "This command deletes a DHCPv4 option definition from the configuration database."
     ],
     "cmd-comment": [
-        "This command includes a list with exactly one option definition specification, comprising an option name and code. The ``server-tags`` list is mandatory and must contain exactly one server tag. Specifying an empty list, a value of ``null``, or multiple server tags will result in an error."
+        "This command includes a list with exactly one option definition specification, comprising an option name and code. The ``server-tags`` list is mandatory and must contain exactly one server tag. Specifying an empty list, a value of ``null``, or multiple server tags will result in an error. As of Kea 3.1.2, before deleting an option definition, the server will first check if there are any options specified that depend upon that defintion. If so the delete command will be rejected with an error message explaining why.  This default behavior may be overridden by setting the optional ``force`` parameter to true."
     ],
     "cmd-syntax": [
         "{",
@@ -14,6 +14,7 @@
         "        \"option-defs\": [ {",
         "            \"code\": <option code>,",
         "            \"space\": <option space>",
+        "            \"force\": false",
         "        } ],",
         "        \"remote\": {",
         "            <specification of the database to connect to>",

diff --git a/src/share/api/remote-option-def6-del.json b/src/share/api/remote-option-def6-del.json
index 9121c6eca6e233979f3f53ad62add87274a99450..5e31a50a10cd00cdf63bdcdb0888dc495734db03 100644 (file)
--- a/src/share/api/remote-option-def6-del.json
+++ b/src/share/api/remote-option-def6-del.json
@@ -5,7 +5,7 @@
         "This command deletes a DHCPv6 option definition from the configuration database."
     ],
     "cmd-comment": [
-        "This command includes a list with exactly one option definition specification, comprising an option name and code. The ``server-tags`` list is mandatory and must contain exactly one server tag. Specifying an empty list, a value of ``null``, or multiple server tags will result in an error."
+        "This command includes a list with exactly one option definition specification, comprising an option name and code. The ``server-tags`` list is mandatory and must contain exactly one server tag. Specifying an empty list, a value of ``null``, or multiple server tags will result in an error. As of Kea 3.1.2, before deleting an option definition, the server will first check if there are any options specified that depend upon that defintion. If so the delete command will be rejected with an error message explaining why.  This default behavior may be overridden by setting the optional ``force`` parameter to true."
     ],
     "cmd-syntax": [
         "{",
@@ -14,6 +14,7 @@
         "        \"option-defs\": [ {",
         "            \"code\": <option code>,",
         "            \"space\": <option space>",
+        "            \"force\": false",
         "        } ],",
         "        \"remote\": {",
         "            <specification of the database to connect to>",