5
0
mirror of git://git.proxmox.com/git/pve-ha-manager.git synced 2025-02-07 05:57:33 +03:00

api: fix/add return description for status endpoint

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>
This commit is contained in:
Fiona Ebner 2023-05-31 10:12:46 +02:00 committed by Thomas Lamprecht
parent 5a9c3a2808
commit afa1aa9cb8

View File

@ -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) = @_;