Extend return value documentation for vmware_guest_disk (#1641)

Extend return value documentation for vmware_guest_disk SUMMARY Document the missing return value disk_changes. Relates to: #621 ISSUE TYPE Docs Pull Request COMPONENT NAME vmware_guest_disk Reviewed-by: Mario Lenz <[email protected]>
ansible-collections · Feb 19, 2023 · ec93a8e · ec93a8e
1 parent 26567aa
commit ec93a8e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/changelogs/fragments/1641_extend_result_docs_guest_disk b/changelogs/fragments/1641_extend_result_docs_guest_disk
@@ -0,0 +1,2 @@
+minor_changes:
+  - vmware_guest_disk - Extend return value documentation for vmware_guest_disk (https://github.com/ansible-collections/community.vmware/pull/1641)
diff --git a/plugins/modules/vmware_guest_disk.py b/plugins/modules/vmware_guest_disk.py
@@ -497,6 +497,14 @@
             "unit_number": 0
         },
     }
+disk_changes:
+    description: result of each task, key is the 0-based index with the same sequence in which the tasks were defined
+    returned: always
+    type: dict
+    sample: {
+        "0": "Disk deleted.",
+        "1": "Disk created."
+    }
 '''
 
 import re
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		minor_changes:
		- vmware_guest_disk - Extend return value documentation for vmware_guest_disk (https://github.com/ansible-collections/community.vmware/pull/1641)