admin/broker: updated maintenance status descriptions.

Signed-off-by: Michal Maslanka <michal@redpanda.com> (cherry picked from commit ffb2854)
vbotbuildovich · Oct 17, 2023 · b202248 · b202248
1 parent a7cd6c0
commit b202248
Showing 1 changed file with 5 additions and 5 deletions.
diff --git a/src/v/redpanda/admin/api-doc/broker.json b/src/v/redpanda/admin/api-doc/broker.json
@@ -304,15 +304,15 @@
         },
         "maintenance_status": {
             "id": "maintenance_status",
-            "description": "Drain status",
+            "description": "Status of maintenance mode",
             "properties": {
                 "draining": {
                     "type": "boolean",
-                    "description": "in maintenance state"
+                    "description": "Flag indicating if maintenance mode is enabled."
                 },
                 "finished": {
                     "type": "boolean",
-                    "description": "drain finished"
+                    "description": "Indicates that draining is finished. Note that the draining flag will always be true if maintenance mode is enable and draining has finished."
                 },
                 "errors": {
                     "type": "boolean",
@@ -349,7 +349,7 @@
                     "description": "number of replicas left on a node"
                 },
                 "allocation_failures": {
-                    "type" : "array",
+                    "type": "array",
                     "items": {
                         "type": "string",
                         "description": "ntp"
@@ -414,4 +414,4 @@
             }
         }
     }
-}
+}