From: Slawek Figiel <slawek@isc.org>
Date: Wed, 24 May 2023 15:40:09 +0000 (+0200)
Subject: [#2815] Update command API references
X-Git-Tag: Kea-2.3.8~37
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=39f624ed5ae85732fa54bf8301945bc8fc720e14;p=thirdparty%2Fkea.git

[#2815] Update command API references
---

diff --git a/src/share/api/reservation-add.json b/src/share/api/reservation-add.json
index d771725613..9115645062 100644
--- a/src/share/api/reservation-add.json
+++ b/src/share/api/reservation-add.json
@@ -5,7 +5,7 @@
         "This command adds a new host reservation. The reservation may include IPv4 addresses, IPv6 addresses, IPv6 prefixes, various identifiers, a class the client will be assigned to, DHCPv4 and DHCPv6 options, and more."
     ],
     "cmd-comment": [
-        "Note that boot-file-name, circuit-id, client-id, ip-address, next-server, and server-hostname are IPv4-specific. ip-addresses, and prefixes are IPv6-specific."
+        "Note that boot-file-name, circuit-id, client-id, ip-address, next-server, and server-hostname are IPv4-specific. ip-addresses, and prefixes are IPv6-specific. Operation-target is optional; default is 'alternate'."
     ],
     "cmd-syntax": [
         "{",
@@ -28,7 +28,8 @@
         "            \"server-hostname\": <string>,",
         "            \"subnet-id\": <integer>,",
         "            \"user-context\": <any valid JSON>",
-        "        }",
+        "        },",
+        "        \"operation-target\": <string (primary, alternate, all, default)>",
         "    }",
         "}"
     ],
diff --git a/src/share/api/reservation-del.json b/src/share/api/reservation-del.json
index 61ec8d7878..b913b139af 100644
--- a/src/share/api/reservation-del.json
+++ b/src/share/api/reservation-del.json
@@ -5,7 +5,7 @@
         "This command deletes an existing host reservation."
     ],
     "cmd-comment": [
-        "The host reservation can be identified by either the (subnet-id, ip-address) pair or a triplet of (subnet-id, identifier-type, identifier)."
+        "The host reservation can be identified by either the (subnet-id, ip-address) pair or a triplet of (subnet-id, identifier-type, identifier). Operation-target is optional; default is 'alternate'."
     ],
     "cmd-syntax": [
         "{",
@@ -14,7 +14,8 @@
         "        \"subnet-id\": <integer>,",
         "        \"ip-address\": <string>,",
         "        \"identifier-type\": <one of 'hw-address', 'duid', 'circuit-id', 'client-id' and 'flex-id'>,",
-        "        \"identifier\": <string>",
+        "        \"identifier\": <string>,",
+        "        \"operation-target\": <string (primary, alternate, all, default)>",
         "    }",
         "}"
     ],
diff --git a/src/share/api/reservation-get-all.json b/src/share/api/reservation-get-all.json
index 5e1eeb594c..19fd18955c 100644
--- a/src/share/api/reservation-get-all.json
+++ b/src/share/api/reservation-get-all.json
@@ -4,11 +4,15 @@
     "brief": [
         "This command retrieves all host reservations for a specified subnet."
     ],
+    "cmd-comment": [
+        "Operation-target is optional; default is 'all'."
+    ],
     "cmd-syntax": [
         "{",
         "    \"command\": \"reservation-get-all\",",
         "    \"arguments\": {",
-        "        \"subnet-id\": <integer>",
+        "        \"subnet-id\": <integer>,",
+        "        \"operation-target\": <string (primary, alternate, all, default)>",
         "    }",
         "}"
     ],
diff --git a/src/share/api/reservation-get-by-hostname.json b/src/share/api/reservation-get-by-hostname.json
index 06d0e5cb94..86f4f225ed 100644
--- a/src/share/api/reservation-get-by-hostname.json
+++ b/src/share/api/reservation-get-by-hostname.json
@@ -4,12 +4,16 @@
     "brief": [
         "This command retrieves all host reservations for a specified hostname and optionally a specified subnet."
     ],
+    "cmd-comment": [
+        "Operation-target is optional; default is 'all'."
+    ],
     "cmd-syntax": [
         "{",
         "    \"command\": \"reservation-get-by-hostname\",",
         "    \"arguments\": {",
         "        \"hostname\": <hostname>,",
-        "        \"subnet-id\": <integer>",
+        "        \"subnet-id\": <integer>,",
+        "        \"operation-target\": <string (primary, alternate, all, default)>",
         "    }",
         "}"
     ],
diff --git a/src/share/api/reservation-get-by-id.json b/src/share/api/reservation-get-by-id.json
index 59958df62e..9f90be88e7 100644
--- a/src/share/api/reservation-get-by-id.json
+++ b/src/share/api/reservation-get-by-id.json
@@ -4,12 +4,16 @@
     "brief": [
         "This command retrieves all host reservations for a specified identifier (type and value)."
     ],
+    "cmd-comment": [
+        "Operation-target is optional; default is 'all'."
+    ],
     "cmd-syntax": [
         "{",
         "    \"command\": \"reservation-get-by-id\",",
         "    \"arguments\": {",
         "        \"identifier-type\": <one of 'hw-address', 'duid', 'circuit-id', 'client-id' and 'flex-id'>,",
-        "        \"identifier\": <string>",
+        "        \"identifier\": <string>,",
+        "        \"operation-target\": <string (primary, alternate, all, default)>",
         "    }",
         "}"
     ],
diff --git a/src/share/api/reservation-get.json b/src/share/api/reservation-get.json
index 16b3f194c7..f42a0ade7e 100644
--- a/src/share/api/reservation-get.json
+++ b/src/share/api/reservation-get.json
@@ -5,7 +5,7 @@
         "This command retrieves an existing host reservation."
     ],
     "cmd-comment": [
-        "The host reservation can be identified by either the (subnet-id, ip-address) pair or a triplet of (subnet-id, identifier-type, identifier)."
+        "The host reservation can be identified by either the (subnet-id, ip-address) pair or a triplet of (subnet-id, identifier-type, identifier). Operation-target is optional; default is 'all'."
     ],
     "cmd-syntax": [
         "{",
@@ -13,7 +13,8 @@
         "    \"arguments\": {",
         "        \"subnet-id\": <integer>,",
         "        \"identifier-type\": <one of 'hw-address', 'duid', 'circuit-id', 'client-id' and 'flex-id'>,",
-        "        \"identifier\": <string>",
+        "        \"identifier\": <string>,",
+        "        \"operation-target\": <string (primary, alternate, all, default)>",
         "    }",
         "}"
     ],
diff --git a/src/share/api/reservation-update.json b/src/share/api/reservation-update.json
index 7af996b6fb..d998e75877 100644
--- a/src/share/api/reservation-update.json
+++ b/src/share/api/reservation-update.json
@@ -5,7 +5,7 @@
         "This command updates an existing host reservation. The reservation has to include host identifiers and a subnet identifier and may include IPv4 addresses, IPv6 addresses, IPv6 prefixes, various identifiers, a class the client will be assigned to, DHCPv4 and DHCPv6 options, and more."
     ],
     "cmd-comment": [
-        "Note that boot-file-name, circuit-id, client-id, ip-address, next-server, and server-hostname are IPv4-specific. ip-addresses, and prefixes are IPv6-specific."
+        "Note that boot-file-name, circuit-id, client-id, ip-address, next-server, and server-hostname are IPv4-specific. ip-addresses, and prefixes are IPv6-specific. Operation-target is optional; default is 'alternate'."
     ],
     "cmd-syntax": [
         "{",
@@ -28,7 +28,8 @@
         "            \"server-hostname\": <string>,",
         "            \"subnet-id\": <integer>,",
         "            \"user-context\": <any valid JSON>",
-        "        }",
+        "        },",
+        "        \"operation-target\": <string (primary, alternate, all, default)>",
         "    }",
         "}"
     ],