openstack: document RETURNS for os_volume (#49559)

Document the "id" and "volume" return values from the os_volume module.
2018-12-10 10:29:34 -07:00 · 2018-12-10 10:29:34 -07:00 · eae81e36fd
commit eae81e36fd
parent 758ac1846b
1 changed files with 14 additions and 0 deletions
--- a/lib/ansible/modules/cloud/openstack/os_volume.py
+++ b/lib/ansible/modules/cloud/openstack/os_volume.py
@ -78,6 +78,20 @@ EXAMPLES = '''
      scheduler_hints:
        same_host: 243e8d3c-8f47-4a61-93d6-7215c344b0c0
 '''
+
+RETURNS = '''
+id:
+  description: Cinder's unique ID for this volume
+  returned: always
+  type: str
+  sample: fcc4ac1c-e249-4fe7-b458-2138bfb44c06
+
+volume:
+  description: Cinder's representation of the volume object
+  returned: always
+  type: dict
+  sample: {'...'}
+'''
 from distutils.version import StrictVersion