ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

RETURNS can include version_added (#25810)

Browse source
This commit is contained in:
John R Barker 2017-06-16 20:17:38 +01:00 committed by GitHub
parent 9c849d5c94
commit 5551e87755
2 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/docsite/rst/dev_guide/developing_modules_documenting.rst
View file

@ -235,6 +235,9 @@ The following fields can be used and are all required unless specified otherwise
Data type Data type
:sample: :sample:
One or more examples. One or more examples.
:version_added:
Only needed if this return was extended after initial Ansible release, i.e. this is greater than the top level `version_added` field.
This is a string, and not a float, i.e. ``version_added: "2.3"``.
:contains: :contains:
Optional, if you set `type: complex` you can detail the dictionary here by repeating the above elements. Optional, if you set `type: complex` you can detail the dictionary here by repeating the above elements.
@ -249,6 +252,9 @@ The following fields can be used and are all required unless specified otherwise
Data type Data type
:sample: :sample:
One or more examples. One or more examples.
:version_added:
Only needed if this return was extended after initial Ansible release, i.e. this is greater than the top level `version_added` field.
This is a string, and not a float, i.e. ``version_added: "2.3"``.
For complex nested returns type can be specified as ``type: complex``. For complex nested returns type can be specified as ``type: complex``.

1
test/sanity/validate-modules/schema.py
View file

@ -64,6 +64,7 @@ def return_schema(data):
Required('description'): Any(list, *string_types), Required('description'): Any(list, *string_types),
Required('returned'): Any(*string_types), Required('returned'): Any(*string_types),
Required('type'): Any('string', 'list', 'boolean', 'dict', 'complex', 'bool', 'float', 'int', 'dictionary', 'str'), Required('type'): Any('string', 'list', 'boolean', 'dict', 'complex', 'bool', 'float', 'int', 'dictionary', 'str'),
'version_added': Any(float, *string_types),
'sample': Any(None, list, dict, int, float, *string_types), 'sample': Any(None, list, dict, int, float, *string_types),
'example': Any(None, list, dict, int, float, *string_types) 'example': Any(None, list, dict, int, float, *string_types)
} }