From: Francis Dupont <fdupont@isc.org>
Date: Mon, 30 Mar 2020 16:50:37 +0000 (+0200)
Subject: [#882] Added lease[46]-get-page api doc
X-Git-Tag: Kea-1.7.7~80
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=eeca3113d448fb166cf65f8e0324a40013bf932a;p=thirdparty%2Fkea.git

[#882] Added lease[46]-get-page api doc
---

diff --git a/doc/sphinx/api-files.txt b/doc/sphinx/api-files.txt
index 1622901089..77225b34b5 100644
--- a/doc/sphinx/api-files.txt
+++ b/doc/sphinx/api-files.txt
@@ -33,6 +33,7 @@ api/lease4-get-all.json
 api/lease4-get-by-client-id.json
 api/lease4-get-by-hostname.json
 api/lease4-get-by-hw-address.json
+api/lease4-get-page.json
 api/lease4-get.json
 api/lease4-update.json
 api/lease4-wipe.json
@@ -43,6 +44,7 @@ api/lease6-del.json
 api/lease6-get-all.json
 api/lease6-get-by-duid.json
 api/lease6-get-by-hostname.json
+api/lease6-get-page.json
 api/lease6-get.json
 api/lease6-update.json
 api/lease6-wipe.json
diff --git a/doc/sphinx/api/cmds-list b/doc/sphinx/api/cmds-list
index 476a92fc0b..34d0623b22 100644
--- a/doc/sphinx/api/cmds-list
+++ b/doc/sphinx/api/cmds-list
@@ -30,6 +30,7 @@ lease4-add
 lease4-del
 lease4-get
 lease4-get-all
+lease4-get-page
 lease4-update
 lease4-wipe
 lease6-add
@@ -37,6 +38,7 @@ lease6-bulk-apply
 lease6-del
 lease6-get
 lease6-get-all
+lease6-get-page
 lease6-update
 lease6-wipe
 lease4-resend-ddns
diff --git a/doc/sphinx/api/lease4-get-page.json b/doc/sphinx/api/lease4-get-page.json
new file mode 100644
index 0000000000..960c87dd3e
--- /dev/null
+++ b/doc/sphinx/api/lease4-get-page.json
@@ -0,0 +1,24 @@
+{
+    "avail": "1.5.0",
+    "brief": [
+        "This command retrieves all IPv4 leases by page."
+    ],
+    "cmd-comment": [
+        "The from address and the page size limit are mandatory."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"lease4-get-page\",",
+        "    \"arguments\": {",
+        "        \"limit\": <integer>,",
+        "        \"from\": <IPv4 address or start>",
+        "    }",
+        "}"
+    ],
+    "description": "See <xref linkend=\"command-lease4-get-page\"/>",
+    "hook": "lease_cmds",
+    "name": "lease4-get-page",
+    "support": [
+        "kea-dhcp4"
+    ]
+}
diff --git a/doc/sphinx/api/lease6-get-page.json b/doc/sphinx/api/lease6-get-page.json
new file mode 100644
index 0000000000..0e6c1c982a
--- /dev/null
+++ b/doc/sphinx/api/lease6-get-page.json
@@ -0,0 +1,23 @@
+{
+    "avail": "1.5.0",
+    "brief": [
+        "This command retrieves all IPv6 leases by page."
+    ],
+    "cmd-comment": [
+        "The from address and the page size limit are mandatory."
+    ],
+    "cmd-syntax": [
+        "{",
+        "    \"command\": \"lease6-get-page\",",
+        "    \"arguments\": {",
+        "        \"limit\": <integer>,",
+        "        \"from\": <IPv6 address or start>",
+        "    }",
+        "}"
+    ],
+    "hook": "lease_cmds",
+    "name": "lease6-get-page",
+    "support": [
+        "kea-dhcp6"
+    ]
+}
diff --git a/doc/sphinx/arm/hooks-ha.rst b/doc/sphinx/arm/hooks-ha.rst
index c9f191ad5c..e874a1da0a 100644
--- a/doc/sphinx/arm/hooks-ha.rst
+++ b/doc/sphinx/arm/hooks-ha.rst
@@ -814,7 +814,8 @@ Controlling Lease-Page Size Limit
 
 An HA-enabled server initiates synchronization of the lease database
 after downtime or upon receiving the ``ha-sync`` command. The server
-uses commands described in :ref:`lease-get-page-cmds` to fetch
+uses commands described in :ref:`command-lease4-get-page` and
+:ref:`command-lease6-get-page` to fetch
 leases from its partner server (lease queries). The size of the results
 page (the maximum number of leases to be returned in a single response
 to one of these commands) can be controlled via configuration of the HA hooks
diff --git a/doc/sphinx/arm/hooks-lease-cmds.rst b/doc/sphinx/arm/hooks-lease-cmds.rst
index ded3ec4bc6..f801e2b9b5 100644
--- a/doc/sphinx/arm/hooks-lease-cmds.rst
+++ b/doc/sphinx/arm/hooks-lease-cmds.rst
@@ -588,7 +588,9 @@ following format:
    restriction on the number of leases returned as a result of this
    command.
 
-.. _lease-get-page-cmds:
+.. _command-lease4-get-page:
+
+.. _command-lease6-get-page:
 
 The lease4-get-page, lease6-get-page Commands
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~