]> git.proxmox.com Git - qemu-server.git/commitdiff
Fix description for vm_config and change description for vm_pending
authorFabian Ebner <f.ebner@proxmox.com>
Tue, 4 Feb 2020 08:41:00 +0000 (09:41 +0100)
committerFabian Grünbichler <f.gruenbichler@proxmox.com>
Wed, 5 Feb 2020 07:37:52 +0000 (08:37 +0100)
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@proxmox.com>
PVE/API2/Qemu.pm

index 18fb8fd8e78531e9b65f7ca1d67fa78dd73eac5f..d0dd2dcb5de0fc5fd169a24555c5d32ac7374c76 100644 (file)
@@ -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' ]],
     },