[#2408] Documented the conflict status code usage

5 files changed, 13 insertions, 1 deletions

diff --git a/src/share/api/lease4-add.json b/src/share/api/lease4-add.json
index c7fbca291d..3e6e83444e 100644
--- a/src/share/api/lease4-add.json
+++ b/src/share/api/lease4-add.json
@@ -19,6 +19,9 @@
     "description": "See <xref linkend=\"idp64\"/>",
     "hook": "lease_cmds",
     "name": "lease4-add",
+    "resp-comment": [
+        "If the returned result is equal to 4, it indicates that the lease could not be created because it was in conflict with the server's state or its notion of the configuration. The High Availability hook library can handle such a result differently than a general error. A general error of 1 can indicate issues with processing the command, database availability etc."
+    ],
     "support": [
         "kea-dhcp4"
     ]
diff --git a/src/share/api/lease4-update.json b/src/share/api/lease4-update.json
index 4cb65fa961..5b3c09e173 100644
--- a/src/share/api/lease4-update.json
+++ b/src/share/api/lease4-update.json
@@ -19,6 +19,9 @@
     "description": "See <xref linkend=\"idp62\"/>",
     "hook": "lease_cmds",
     "name": "lease4-update",
+    "resp-comment": [
+        "If the returned result is equal to 4, it indicates that the lease could not be updated because it was in conflict with the server's state or its notion of the configuration. The High Availability hook library can handle such a result differently than a general error. A general error of 1 can indicate issues with processing the command, database availability etc."
+    ],
     "support": [
         "kea-dhcp4"
     ]
diff --git a/src/share/api/lease6-add.json b/src/share/api/lease6-add.json
index 5c4ba5abfa..2760c422b3 100644
--- a/src/share/api/lease6-add.json
+++ b/src/share/api/lease6-add.json
@@ -26,6 +26,9 @@
         "or",
         "{ \"result\": 1, \"text\": \"missing parameter 'ip-address' (<string>:3:19)\" }"
     ],
+    "resp-comment": [
+        "If the returned result is equal to 4, it indicates that the lease could not be created because it was in conflict with the server's state or its notion of the configuration. The High Availability hook library can handle such a result differently than a general error. A general error of 1 can indicate issues with processing the command, database availability etc."
+    ],
     "support": [
         "kea-dhcp6"
     ]
diff --git a/src/share/api/lease6-bulk-apply.json b/src/share/api/lease6-bulk-apply.json
index 2958e41830..db86b655d0 100644
--- a/src/share/api/lease6-bulk-apply.json
+++ b/src/share/api/lease6-bulk-apply.json
@@ -43,7 +43,7 @@
     "hook": "lease_cmds",
     "name": "lease6-bulk-apply",
     "resp-comment": [
-        "The \"failed-deleted-leases\" holds the list of leases which failed to delete; this includes leases which were not found in the database. The \"failed-leases\" includes the list of leases which failed to create or update. For each lease for which there was an error during processing, insertion into the database, etc., the result is set to 1. For each lease which was not deleted because the server did not find it in the database, the result of 3 is returned."
+        "The \"failed-deleted-leases\" holds the list of leases which failed to delete; this includes leases which were not found in the database. The \"failed-leases\" includes the list of leases which failed to create or update. For each lease for which there was an error during processing, insertion into the database, etc., the result is set to 1. If an error occurs due to a conflict between the lease and the server's configuration or state, the result of 4 is returned instead of 1. For each lease which was not deleted because the server did not find it in the database, the result of 3 is returned."
     ],
     "resp-syntax": [
         "{",
diff --git a/src/share/api/lease6-update.json b/src/share/api/lease6-update.json
index b0c871ce13..0c27104c57 100644
--- a/src/share/api/lease6-update.json
+++ b/src/share/api/lease6-update.json
@@ -21,6 +21,9 @@
     "description": "See <xref linkend=\"idp62\"/>",
     "hook": "lease_cmds",
     "name": "lease6-update",
+    "resp-comment": [
+        "If the returned result is equal to 4, it indicates that the lease could not be updated because it was in conflict with the server's state or its notion of the configuration. The High Availability hook library can handle such a result differently than a general error. A general error of 1 can indicate issues with processing the command, database availability etc."
+    ],
     "support": [
         "kea-dhcp6"
     ]