mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-20 17:31:24 -07:00
[PR #9395/3048d530 backport][stable-9] g*.py: normalize docs (#9414)
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>
(cherry picked from commit 3048d5305d
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
parent
87d63c5bed
commit
a66b9fc5c9
36 changed files with 633 additions and 683 deletions
|
@ -9,15 +9,15 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
DOCUMENTATION = r"""
|
||||
module: gitlab_group_variable
|
||||
short_description: Creates, updates, or deletes GitLab groups variables
|
||||
version_added: 1.2.0
|
||||
description:
|
||||
- Creates a group variable if it does not exist.
|
||||
- When a group variable does exist, its value will be updated when the values are different.
|
||||
- Variables which are untouched in the playbook, but are not untouched in the GitLab group,
|
||||
they stay untouched (O(purge=false)) or will be deleted (O(purge=true)).
|
||||
- Variables which are untouched in the playbook, but are not untouched in the GitLab group, they stay untouched (O(purge=false))
|
||||
or will be deleted (O(purge=true)).
|
||||
author:
|
||||
- Florent Madiot (@scodeman)
|
||||
requirements:
|
||||
|
@ -53,8 +53,8 @@ options:
|
|||
vars:
|
||||
description:
|
||||
- When the list element is a simple key-value pair, masked, raw and protected will be set to false.
|
||||
- When the list element is a dict with the keys C(value), C(masked), C(raw) and C(protected), the user can
|
||||
have full control about whether a value should be masked, raw, protected or both.
|
||||
- When the list element is a dict with the keys C(value), C(masked), C(raw) and C(protected), the user can have full
|
||||
control about whether a value should be masked, raw, protected or both.
|
||||
- Support for group variables requires GitLab >= 9.5.
|
||||
- Support for environment_scope requires GitLab Premium >= 13.11.
|
||||
- Support for protected values requires GitLab >= 9.3.
|
||||
|
@ -62,8 +62,8 @@ options:
|
|||
- Support for raw values requires GitLab >= 15.7.
|
||||
- A C(value) must be a string or a number.
|
||||
- Field C(variable_type) must be a string with either V(env_var), which is the default, or V(file).
|
||||
- When a value is masked, it must be in Base64 and have a length of at least 8 characters.
|
||||
See GitLab documentation on acceptable values for a masked variable (U(https://docs.gitlab.com/ce/ci/variables/#masked-variables)).
|
||||
- When a value is masked, it must be in Base64 and have a length of at least 8 characters. See GitLab documentation
|
||||
on acceptable values for a masked variable (U(https://docs.gitlab.com/ce/ci/variables/#masked-variables)).
|
||||
default: {}
|
||||
type: dict
|
||||
variables:
|
||||
|
@ -106,17 +106,17 @@ options:
|
|||
description:
|
||||
- Whether a variable is an environment variable (V(env_var)) or a file (V(file)).
|
||||
type: str
|
||||
choices: [ "env_var", "file" ]
|
||||
choices: ["env_var", "file"]
|
||||
default: env_var
|
||||
environment_scope:
|
||||
description:
|
||||
- The scope for the variable.
|
||||
type: str
|
||||
default: '*'
|
||||
'''
|
||||
"""
|
||||
|
||||
|
||||
EXAMPLES = r'''
|
||||
EXAMPLES = r"""
|
||||
- name: Set or update some CI/CD variables
|
||||
community.general.gitlab_group_variable:
|
||||
api_url: https://gitlab.com
|
||||
|
@ -173,9 +173,9 @@ EXAMPLES = r'''
|
|||
state: absent
|
||||
vars:
|
||||
ACCESS_KEY_ID: abc123
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = r'''
|
||||
RETURN = r"""
|
||||
group_variable:
|
||||
description: Four lists of the variablenames which were added, updated, removed or exist.
|
||||
returned: always
|
||||
|
@ -201,7 +201,7 @@ group_variable:
|
|||
returned: always
|
||||
type: list
|
||||
sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY']
|
||||
'''
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.api import basic_auth_argument_spec
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue