[pve-devel] [PATCH ha-manager] api: fix/add return description for status endpoint

[pve-devel] [PATCH ha-manager] api: fix/add return description for status endpoint

[Fiona Ebner]

The fact that no 'items' was specified made the api-viewer throw a
JavaScript exception: retinf.items is undefined

Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
---
 src/PVE/API2/HA/Status.pm | 65 ++++++++++++++++++++++++++++++++++++++-
 1 file changed, 64 insertions(+), 1 deletion(-)

diff --git a/src/PVE/API2/HA/Status.pm b/src/PVE/API2/HA/Status.pm
index 201e17e..dc21049 100644
--- a/src/PVE/API2/HA/Status.pm
+++ b/src/PVE/API2/HA/Status.pm
@@ -71,7 +71,70 @@ __PACKAGE__->register_method ({
 	additionalProperties => 0,
 	properties => {},
     },
-    returns => { type => 'array' },
+    returns => {
+	type => 'array',
+	items => {
+	    type => 'object',
+	    properties => {
+		id => {
+		    description => "Status entry ID (quorum, master, lrm:<node>, service:<sid>).",
+		    type => "string",
+		},
+		node => {
+		    description => "Node associated to status entry.",
+		    type => "string",
+		},
+		status => {
+		    description => "Status of the entry (value depends on type).",
+		    type => "string",
+		},
+		type => {
+		    description => "Type of status entry.",
+		    enum => ["quorum", "master", "lrm", "service"],
+		},
+		quorate => {
+		    description => "For type 'quorum'. Whether the cluster is quorate or not.",
+		    type => "boolean",
+		    optional => 1,
+		},
+		timestamp => {
+		    description => "For type 'lrm','master'. Timestamp of the status information.",
+		    type => "integer",
+		    optional => 1,
+		},
+		crm_state => {
+		    description => "For type 'service'. Service state as seen by the CRM.",
+		    type => "string",
+		    optional => 1,
+		},
+		max_relocate => {
+		    description => "For type 'service'.",
+		    type => "integer",
+		    optional => 1,
+		},
+		max_restart => {
+		    description => "For type 'service'.",
+		    type => "integer",
+		    optional => 1,
+		},
+		request_state => {
+		    description => "For type 'service'. Requested service state.",
+		    type => "string",
+		    optional => 1,
+		},
+		sid => {
+		    description => "For type 'service'. Service ID.",
+		    type => "string",
+		    optional => 1,
+		},
+		state => {
+		    description => "For type 'service'. Verbose service state.",
+		    type => "string",
+		    optional => 1,
+		},
+	    },
+	},
+    },
     code => sub {
 	my ($param) = @_;
 
-- 
2.39.2

[pve-devel] applied: [PATCH ha-manager] api: fix/add return description for status endpoint

[Thomas Lamprecht]

Am 31/05/2023 um 10:12 schrieb Fiona Ebner:
> The fact that no 'items' was specified made the api-viewer throw a
> JavaScript exception: retinf.items is undefined
> 
> Signed-off-by: Fiona Ebner <f.ebner@proxmox.com>
> ---
>  src/PVE/API2/HA/Status.pm | 65 ++++++++++++++++++++++++++++++++++++++-
>  1 file changed, 64 insertions(+), 1 deletion(-)
> 
>

applied, thanks!