[pve-devel] [pve-container] vmlist: document return properties

[Dietmar Maurer]

Signed-off-by: Dietmar Maurer <dietmar at proxmox.com>
---
 src/PVE/API2/LXC.pm | 43 ++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 42 insertions(+), 1 deletion(-)

diff --git a/src/PVE/API2/LXC.pm b/src/PVE/API2/LXC.pm
index 55e6310..b65143e 100644
--- a/src/PVE/API2/LXC.pm
+++ b/src/PVE/API2/LXC.pm
@@ -74,7 +74,48 @@ __PACKAGE__->register_method({
 	type => 'array',
 	items => {
 	    type => "object",
-	    properties => {},
+	    properties => {
+		vmid => get_standard_option('pve-vmid'),
+		status => {
+		    description => "LXC Container status.",
+		    type => 'string',
+		    enum => ['stopped', 'running'],
+		},
+		maxmem => {
+		    description => "Maximum memory in bytes.",
+		    type => 'integer',
+		    optional => 1,
+		    renderer => 'bytes',
+		},
+		maxswap => {
+		    description => "Maximum SWAP memory in bytes.",
+		    type => 'integer',
+		    optional => 1,
+		    renderer => 'bytes',
+		},
+		maxdisk => {
+		    description => "Root disk size in bytes.",
+		    type => 'integer',
+		    optional => 1,
+		    renderer => 'bytes',
+		},
+		name => {
+		    description => "Container name.",
+		    type => 'string',
+		    optional => 1,
+		},
+		uptime => {
+		    description => "Uptime.",
+		    type => 'integer',
+		    optional => 1,
+		    renderer => 'duration',
+		},
+		cpus => {
+		    description => "Maximum usable CPUs.",
+		    type => 'number',
+		    optional => 1,
+		},
+	    },
 	},
 	links => [ { rel => 'child', href => "{vmid}" } ],
     },
-- 
2.11.0