]> git.proxmox.com Git - pve-storage.git/commitdiff
PVE::API2::Storage::Content::index - document return values
authorDietmar Maurer <dietmar@proxmox.com>
Thu, 9 Aug 2018 06:53:24 +0000 (08:53 +0200)
committerDietmar Maurer <dietmar@proxmox.com>
Thu, 9 Aug 2018 06:53:24 +0000 (08:53 +0200)
PVE/API2/Storage/Content.pm

index daf8b95ef24c80a818075a42c76a56e3506ee865..e941cb653ca8bb1d60ffadad5c9d22f508f42275 100644 (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}" } ],