mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-22 18:31:25 -07:00
g*.py: normalize docs (#9395)
* g*.py: normalize docs * Update plugins/modules/gandi_livedns.py Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
parent
df42f29e53
commit
3048d5305d
36 changed files with 633 additions and 683 deletions
|
@ -12,7 +12,7 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
DOCUMENTATION = r"""
|
||||
module: gitlab_project_access_token
|
||||
short_description: Manages GitLab project access tokens
|
||||
version_added: 8.4.0
|
||||
|
@ -27,11 +27,10 @@ extends_documentation_fragment:
|
|||
- community.general.gitlab
|
||||
- community.general.attributes
|
||||
notes:
|
||||
- Access tokens can not be changed. If a parameter needs to be changed, an acceess token has to be recreated.
|
||||
Whether tokens will be recreated is controlled by the O(recreate) option, which defaults to V(never).
|
||||
- Access tokens can not be changed. If a parameter needs to be changed, an acceess token has to be recreated. Whether tokens
|
||||
will be recreated is controlled by the O(recreate) option, which defaults to V(never).
|
||||
- Token string is contained in the result only when access token is created or recreated. It can not be fetched afterwards.
|
||||
- Token matching is done by comparing O(name) option.
|
||||
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
|
@ -56,7 +55,8 @@ options:
|
|||
type: list
|
||||
elements: str
|
||||
aliases: ["scope"]
|
||||
choices: ["api", "read_api", "read_registry", "write_registry", "read_repository", "write_repository", "create_runner", "ai_features", "k8s_proxy"]
|
||||
choices: ["api", "read_api", "read_registry", "write_registry", "read_repository", "write_repository", "create_runner",
|
||||
"ai_features", "k8s_proxy"]
|
||||
access_level:
|
||||
description:
|
||||
- Access level of the access token.
|
||||
|
@ -84,10 +84,10 @@ options:
|
|||
- When V(absent) it will be removed from the project if it exists.
|
||||
default: present
|
||||
type: str
|
||||
choices: [ "present", "absent" ]
|
||||
'''
|
||||
choices: ["present", "absent"]
|
||||
"""
|
||||
|
||||
EXAMPLES = r'''
|
||||
EXAMPLES = r"""
|
||||
- name: "Creating a project access token"
|
||||
community.general.gitlab_project_access_token:
|
||||
api_url: https://gitlab.example.com/
|
||||
|
@ -131,16 +131,16 @@ EXAMPLES = r'''
|
|||
- write_repository
|
||||
recreate: state_change
|
||||
state: present
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = r'''
|
||||
RETURN = r"""
|
||||
access_token:
|
||||
description:
|
||||
- API object.
|
||||
- Only contains the value of the token if the token was created or recreated.
|
||||
returned: success and O(state=present)
|
||||
type: dict
|
||||
'''
|
||||
"""
|
||||
|
||||
from datetime import datetime
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue