From: Marcin Siodelski <marcin@isc.org>
Date: Mon, 27 May 2019 13:51:45 +0000 (+0200)
Subject: [#71,!314] Regenerated API docs.
X-Git-Tag: Kea-1.6.0-beta~49
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f5eff5e12e1be90e014b9fd5e7a8f87ad4635329;p=thirdparty%2Fkea.git

[#71,!314] Regenerated API docs.
---

diff --git a/doc/guide/api.xml b/doc/guide/api.xml
index 6a3d5dcf9c..a1a37e599f 100644
--- a/doc/guide/api.xml
+++ b/doc/guide/api.xml
@@ -9,7 +9,7 @@
 <!-- autogenerated using cmd_docgen. Do not edit by hand! -->
 <appendix xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="api">
   <title>API Reference</title>
-  <para>Kea currently supports 119 commands:
+  <para>Kea currently supports 121 commands:
 <command><link linkend="ref-build-report">build-report</link></command>
 , <command><link linkend="ref-cache-clear">cache-clear</link></command>
 , <command><link linkend="ref-cache-get">cache-get</link></command>
@@ -526,7 +526,7 @@ Result is an integer representation of the status. Currently supported statuses
 <!-- start of cache-get-by-id -->
 <section xml:id="reference-cache-get-by-id">
 <title>cache-get-by-id reference</title>
-<para xml:id="ref-cache-get-by-id"><command>cache-get-by-id</command> - Returns entries matching the given identifier from the host cache.</para>
+<para xml:id="ref-cache-get-by-id"><command>cache-get-by-id</command> - Returns entries matching the given identifier from  the host cache.</para>
 
 <para>Supported by: <command><link linkend="commands-kea-dhcp4">kea-dhcp4</link></command>, <command><link linkend="commands-kea-dhcp6">kea-dhcp6</link></command></para>
 
@@ -539,15 +539,14 @@ Result is an integer representation of the status. Currently supported statuses
     "command": "cache-get-by-id",
     "arguments": {
         "hw-address": "01:02:03:04:05:06"
-    }
-}</screen>
+    }</screen>
 </para>
 
 <para>Response syntax:
   <screen>{
     "result": 0
     "text": "2 entries returned."
-    "arguments": &lt;list of cashed host&gt;
+    "arguments": &lt;list of host reservations&gt;
 }</screen>
 Result is an integer representation of the status. Currently supported statuses are:
 <itemizedlist>
@@ -717,7 +716,7 @@ Result is an integer representation of the status. Currently supported statuses
 <!-- start of cache-size -->
 <section xml:id="reference-cache-size">
 <title>cache-size reference</title>
-<para xml:id="ref-cache-size"><command>cache-size</command> - This command returns the number of cached host reservations.</para>
+<para xml:id="ref-cache-size"><command>cache-size</command> - Returns number of entries of the host cache.</para>
 
 <para>Supported by: <command><link linkend="commands-kea-dhcp4">kea-dhcp4</link></command>, <command><link linkend="commands-kea-dhcp6">kea-dhcp6</link></command></para>
 
@@ -733,11 +732,10 @@ Result is an integer representation of the status. Currently supported statuses
 
 <para>Response syntax:
   <screen>{
-    "result": 0,
-    "text": "123 entries.",
+    "result": 0
+    "text": "123 entries."
     "arguments": { "size": 123 }
-}
-</screen>
+}</screen>
 Result is an integer representation of the status. Currently supported statuses are:
 <itemizedlist>
   <listitem><para>0 - success</para></listitem>
@@ -1371,8 +1369,8 @@ Result is an integer representation of the status. Currently supported statuses
 <!-- start of ha-sync -->
 <section xml:id="reference-ha-sync">
 <title>ha-sync reference</title>
-<para xml:id="ref-ha-sync"><command>ha-sync</command> - The command is issued to instruct the server running in HA mode to
-synchronize its local lease database with the selected peer.</para>
+<para xml:id="ref-ha-sync"><command>ha-sync</command> - The command is issued to instruct the server running in HA mode to 
+              synchronize its local lease database with the selected peer.</para>
 
 <para>Supported by: <command><link linkend="commands-kea-dhcp4">kea-dhcp4</link></command>, <command><link linkend="commands-kea-dhcp6">kea-dhcp6</link></command></para>
 
@@ -3865,7 +3863,15 @@ The provided list must cotain exactly one option specification.</para>
 <para>Response syntax:
   <screen>{
     "result": 0,
-    "text": "DHCPv4 option set."
+    "text": "DHCPv4 option set.",
+    "arguments": {
+        "options": [
+            {
+                "code": &lt;option code&gt;,
+                "space": &lt;option space&gt;
+            }
+        ]
+    }
 }</screen>
 Result is an integer representation of the status. Currently supported statuses are:
 <itemizedlist>
@@ -4053,7 +4059,15 @@ The provided list must cotain exactly one option specification.</para>
 <para>Response syntax:
   <screen>{
     "result": 0,
-    "text": "DHCPv6 option set."
+    "text": "DHCPv6 option set.",
+    "arguments": {
+        "options": [
+            {
+                "code": &lt;option code&gt;,
+                "space": &lt;option space&gt;
+            }
+        ]
+    }
 }</screen>
 Result is an integer representation of the status. Currently supported statuses are:
 <itemizedlist>