ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-06-29 03:30:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

[stable-10] Adjust YAML in module docs (#10240) (#10257)

Browse source 
Adjust YAML in module docs (#10240)

* Adjust YAML in module docs.

* adjust modules

---------


(cherry picked from commit e8f965fbf8)

Co-authored-by: Alexei Znamensky <russoz@gmail.com>
This commit is contained in:
Felix Fontein 2025-06-16 18:02:09 +02:00 • committed by GitHub
parent 8196cacff8
commit 2b48825499
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
87 changed files with 2071 additions and 1660 deletions
Download patch file Download diff file Expand all files Collapse all files

34
plugins/modules/github_key.py
View file

@ -57,20 +57,42 @@ deleted_keys:
description: An array of key objects that were deleted. Only present on state=absent.
type: list
returned: When state=absent
sample: [{'id': 0, 'key': 'BASE64 encoded key', 'url': 'http://example.com/github key', 'created_at': 'YYYY-MM-DDTHH:MM:SZ',
'read_only': false}]
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: 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}]
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: 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}
sample:
{
"id": 0,
"key": "BASE64 encoded key",
"url": "http://example.com/github key",
"created_at": "YYYY-MM-DDTHH:MM:SZ",
"read_only": false
}
"""
EXAMPLES = r"""