PVE::API2::Storage::Content::index - document return values

This commit is contained in:
Dietmar Maurer
2018-08-09 08:53:24 +02:00
parent 4d12dbffc4
commit 2654942813

View File

@ -50,9 +50,36 @@ __PACKAGE__->register_method ({
items => {
type => "object",
properties => {
volid => {
type => 'string'
}
volid => {
description => "Volume identifier.",
type => 'string',
},
vmid => {
description => "Associated Owner VMID.",
type => 'integer',
optional => 1,
},
parent => {
description => "Volume identifier of parent (for linked cloned).",
type => 'string',
optional => 1,
},
'format' => {
description => "Format identifier ('raw', 'qcow2', 'subvol', 'iso', 'tgz' ...)",
type => 'string',
},
size => {
description => "Volume size in bytes.",
type => 'integer',
renderer => 'bytes',
},
used => {
description => "Used space. Please note that most storage plugins " .
"does not report anything useful here.",
type => 'integer',
renderer => 'bytes',
optional => 1,
},
},
},
links => [ { rel => 'child', href => "{volid}" } ],