[PATCH qemu-server 4/7] api: qemu: add verbose description for shutdown and reboot timeouts

[Daniel Kral <d.kral@proxmox.com>]

Add documentation for the fallback behavior of the shutdown timeout
parameter for the vm_shutdown and vm_reboot API endpoints.

Signed-off-by: Daniel Kral <d.kral@proxmox.com>
---
 src/PVE/API2/Qemu.pm | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/PVE/API2/Qemu.pm b/src/PVE/API2/Qemu.pm
index bf6ade58..304805dc 100644
--- a/src/PVE/API2/Qemu.pm
+++ b/src/PVE/API2/Qemu.pm
@@ -3857,6 +3857,10 @@ __PACKAGE__->register_method({
             skiplock => get_standard_option('skiplock'),
             timeout => {
                 description => "Maximum timeout in seconds.",
+                verbose_description => "Maximum timeout in seconds.\n\n"
+                    . "If the parameter is not provided, the shutdown timeout will fallback"
+                    . " to the shutdown timeout value in the VM config. If none is set there,"
+                    . " the timeout defaults to 60 seconds.",
                 type => 'integer',
                 minimum => 0,
                 optional => 1,
@@ -3971,6 +3975,10 @@ __PACKAGE__->register_method({
             ),
             timeout => {
                 description => "Maximum timeout in seconds for the shutdown.",
+                verbose_description => "Maximum timeout in seconds for the shutdown.\n\n"
+                    . "If the parameter is not provided, the shutdown timeout will fallback"
+                    . " to the shutdown timeout value in the VM config. If none is set there,"
+                    . " the timeout defaults to 60 seconds.",
                 type => 'integer',
                 minimum => 0,
                 optional => 1,
-- 
2.47.3