api: status: document return types
this is useful, e.g. when we want to generate bindings for this api call Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
This commit is contained in:
committed by
Wolfgang Bumiller
parent
02acde02b6
commit
9eb914de16
@ -300,7 +300,50 @@ __PACKAGE__->register_method({
|
|||||||
},
|
},
|
||||||
returns => {
|
returns => {
|
||||||
type => "object",
|
type => "object",
|
||||||
properties => {},
|
properties => {
|
||||||
|
type => {
|
||||||
|
description => "Storage type.",
|
||||||
|
type => 'string',
|
||||||
|
},
|
||||||
|
content => {
|
||||||
|
description => "Allowed storage content types.",
|
||||||
|
type => 'string',
|
||||||
|
format => 'pve-storage-content-list',
|
||||||
|
},
|
||||||
|
enabled => {
|
||||||
|
description => "Set when storage is enabled (not disabled).",
|
||||||
|
type => 'boolean',
|
||||||
|
optional => 1,
|
||||||
|
},
|
||||||
|
active => {
|
||||||
|
description => "Set when storage is accessible.",
|
||||||
|
type => 'boolean',
|
||||||
|
optional => 1,
|
||||||
|
},
|
||||||
|
shared => {
|
||||||
|
description => "Shared flag from storage configuration.",
|
||||||
|
type => 'boolean',
|
||||||
|
optional => 1,
|
||||||
|
},
|
||||||
|
total => {
|
||||||
|
description => "Total storage space in bytes.",
|
||||||
|
type => 'integer',
|
||||||
|
renderer => 'bytes',
|
||||||
|
optional => 1,
|
||||||
|
},
|
||||||
|
used => {
|
||||||
|
description => "Used storage space in bytes.",
|
||||||
|
type => 'integer',
|
||||||
|
renderer => 'bytes',
|
||||||
|
optional => 1,
|
||||||
|
},
|
||||||
|
avail => {
|
||||||
|
description => "Available storage space in bytes.",
|
||||||
|
type => 'integer',
|
||||||
|
renderer => 'bytes',
|
||||||
|
optional => 1,
|
||||||
|
},
|
||||||
|
},
|
||||||
},
|
},
|
||||||
code => sub {
|
code => sub {
|
||||||
my ($param) = @_;
|
my ($param) = @_;
|
||||||
|
|||||||
Reference in New Issue
Block a user