[#998,!588] Updated ha-heartbeat api doc.

diff --git a/doc/sphinx/api/ha-heartbeat.json b/doc/sphinx/api/ha-heartbeat.json
index 15d5514c5e91cd41b59522fda5aba25a9926af5e..e4da52ad0b7942769907ca9e71b04411b9030cff 100644 (file)
--- a/doc/sphinx/api/ha-heartbeat.json
+++ b/doc/sphinx/api/ha-heartbeat.json
@@ -1,12 +1,12 @@
 {
     "avail": "1.4.0",
     "brief": [
-        "This command is sent internally by a Kea partner when operating in High-Availability (HA) mode. It retrieves the server's HA state and clock value."
+        "This command is sent internally by a Kea partner when operating in High Availability (HA) mode or by the system administrator to verify the state of the servers with regards to the High Availability. It retrieves the server's HA state and clock value."
     ],
     "cmd-syntax": [
         "{",
         "    \"command\": \"ha-heartbeat\"",
-        "    }"
+        "}"
     ],
     "description": "See <xref linkend=\"ha-server-states\"/>",
     "hook": "high_availability",