RETURNS can include version_added (#25810)
This commit is contained in:
parent
9c849d5c94
commit
5551e87755
2 changed files with 7 additions and 0 deletions
|
@ -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``.
|
||||||
|
|
|
@ -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)
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue