internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-04-05 10:13:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve module docs (#2638)

Browse Source
This commit is contained in:
Ryan Brown
2016-07-29 12:31:55 -04:00
committed by Matt Clay
parent 210b6be359
commit ea5cd3941b
1 changed files with 10 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
lib/ansible/modules/extras/source_control/github_key.py
View File

@@ -54,18 +54,20 @@ author: Robert Estelle (@erydo)
RETURN = '''
deleted_keys:
description: Keys that were deleted, if any.
description: An array of key objects that were deleted. Only present on state=absent
type: list
returned: When state=absent
type: list
sample: [{'id': 0, 'key': 'BASE64 encoded key', 'url': 'http://example.com/github key', 'created_at': 'YYYY-MM-DDTHH:MM:SZ', 'read_only': False}]
matching_keys:
description: Keys that match the specified name.
returned: When state=present
description: An array of keys matching the specified name. Only present on state=present
type: list
returned: When state=present
sample: [{'id': 0, 'key': 'BASE64 encoded key', 'url': 'http://example.com/github key', 'created_at': 'YYYY-MM-DDTHH:MM:SZ', 'read_only': False}]
key:
description: The key created.
returned: When state=present and a new key is created.
description: Metadata about the key just created. Only present on state=present
type: dict
returned: success
sample: {'id': 0, 'key': 'BASE64 encoded key', 'url': 'http://example.com/github key', 'created_at': 'YYYY-MM-DDTHH:MM:SZ', 'read_only': False}
'''
EXAMPLES = '''