From 2654942813dbb6595be89564cfe8ca39e151d613 Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Thu, 9 Aug 2018 08:53:24 +0200 Subject: [PATCH] PVE::API2::Storage::Content::index - document return values --- PVE/API2/Storage/Content.pm | 33 ++++++++++++++++++++++++++++++--- 1 file changed, 30 insertions(+), 3 deletions(-) diff --git a/PVE/API2/Storage/Content.pm b/PVE/API2/Storage/Content.pm index daf8b95..e941cb6 100644 --- a/PVE/API2/Storage/Content.pm +++ b/PVE/API2/Storage/Content.pm @@ -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}" } ],