[pve-devel] [PATCH qemu-server] Fix description for vm_config and change description for vm_pending

Fabian Ebner f.ebner at proxmox.com
Tue Feb 4 09:41:00 CET 2020


The description for vm_config was out of date and from the description
for vm_pending it was hard to tell what the difference to vm_config was.

Signed-off-by: Fabian Ebner <f.ebner at proxmox.com>
---
 PVE/API2/Qemu.pm | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/PVE/API2/Qemu.pm b/PVE/API2/Qemu.pm
index e15c0c3..8c93af6 100644
--- a/PVE/API2/Qemu.pm
+++ b/PVE/API2/Qemu.pm
@@ -823,7 +823,8 @@ __PACKAGE__->register_method({
     path => '{vmid}/config',
     method => 'GET',
     proxyto => 'node',
-    description => "Get current virtual machine configuration. This does not include pending configuration changes (see 'pending' API).",
+    description => "Get the virtual machine configuration with pending configuration " .
+	"changes applied. Set the 'current' parameter to get the current configuration instead.",
     permissions => {
 	check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
     },
@@ -849,7 +850,7 @@ __PACKAGE__->register_method({
 	},
     },
     returns => {
-	description => "The current VM configuration.",
+	description => "The VM configuration.",
 	type => "object",
 	properties => PVE::QemuServer::json_config_properties({
 	    digest => {
@@ -881,7 +882,7 @@ __PACKAGE__->register_method({
     path => '{vmid}/pending',
     method => 'GET',
     proxyto => 'node',
-    description => "Get virtual machine configuration, including pending changes.",
+    description => "Get the virtual machine configuration with both current and pending values.",
     permissions => {
 	check => ['perm', '/vms/{vmid}', [ 'VM.Audit' ]],
     },
-- 
2.20.1




More information about the pve-devel mailing list