[#1087] Updated status-get description

The HA specific part of the status-get command was updated.

doc/sphinx/api/status-get.json

@@ -21,6 +21,9 @@
         "        \"pid\": <integer>,",
         "        \"uptime\": <uptime in seconds>,",
         "        \"reload\": <time since reload in seconds>,",
+        "        \"high-availability\": [",
+        "            {",
+        "                \"ha-mode\": <HA mode configured for this relationship>",
         "                \"ha-servers\": {",
         "                    \"local\": {",
         "                        \"role\": <role of this server as in the configuration file>,",
@@ -36,6 +39,8 @@
         "                    }",
         "                }",
         "            }",
+        "        ]",
+        "    }",
         "}"
     ],
 

doc/sphinx/arm/hooks-ha.rst

@@ -1586,6 +1586,8 @@ the HA status of two load balancing servers:
            "pid": 1234,
            "uptime": 3024,
            "reload": 1111,
+           "high-availability": [
+               {
                    "ha-mode": "load-balancing",
                    "ha-servers": {
                        "local": {
@@ -1607,7 +1609,24 @@ the HA status of two load balancing servers:
                        }
                    }
                }
+           ]
        }
+   }
+
+The ``high-availability`` argument is a list which currently always comprises
+one element. There are plans to extend the HA implementation to facilitate
+multiple HA relationships for a single server instance. In that case, the
+returned list will comprise more elements, each describing the status of
+a different relationship in which the server participates. Currently, it
+is only one status.
+
+.. note::
+
+   In Kea 1.7.8 an incompatible change was introduced to the syntax of the
+   ``status-get`` response. Previously, the HA status for a single relationship
+   was returned within the ``arguments`` map. Currently, the returned status
+   is enclosed in the list as described above. Any existing code relying on the
+   previous syntax must be updated to work with the new Kea versions.
 
 
 The ``ha-servers`` map contains two structures: ``local`` and ``remote``. The former