mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-23 10:51: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,8 +9,7 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: gitlab_group
|
||||
short_description: Creates/updates/deletes GitLab Groups
|
||||
description:
|
||||
|
@ -97,12 +96,12 @@ options:
|
|||
type: str
|
||||
parent:
|
||||
description:
|
||||
- Allow to create subgroups
|
||||
- Id or Full path of parent group in the form of group/name
|
||||
- Allow to create subgroups.
|
||||
- Id or Full path of parent group in the form of group/name.
|
||||
type: str
|
||||
path:
|
||||
description:
|
||||
- The path of the group you want to create, this will be api_url/group_path
|
||||
- The path of the group you want to create, this will be api_url/group_path.
|
||||
- If not supplied, the group_name will be used.
|
||||
type: str
|
||||
prevent_forking_outside_group:
|
||||
|
@ -146,7 +145,7 @@ options:
|
|||
version_added: 3.7.0
|
||||
state:
|
||||
description:
|
||||
- create or delete group.
|
||||
- Create or delete group.
|
||||
- Possible values are present and absent.
|
||||
default: present
|
||||
type: str
|
||||
|
@ -164,7 +163,7 @@ options:
|
|||
version_added: 9.5.0
|
||||
visibility:
|
||||
description:
|
||||
- Default visibility of the group
|
||||
- Default visibility of the group.
|
||||
choices: ["private", "internal", "public"]
|
||||
default: private
|
||||
type: str
|
||||
|
@ -176,9 +175,9 @@ options:
|
|||
choices: ["enabled", "private", "disabled"]
|
||||
type: str
|
||||
version_added: 9.5.0
|
||||
'''
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
- name: "Delete GitLab Group"
|
||||
community.general.gitlab_group:
|
||||
api_url: https://gitlab.example.com/
|
||||
|
@ -221,31 +220,31 @@ EXAMPLES = '''
|
|||
project_creation_level: noone
|
||||
auto_devops_enabled: false
|
||||
subgroup_creation_level: maintainer
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = '''
|
||||
RETURN = r"""
|
||||
msg:
|
||||
description: Success or failure message
|
||||
description: Success or failure message.
|
||||
returned: always
|
||||
type: str
|
||||
sample: "Success"
|
||||
|
||||
result:
|
||||
description: json parsed response from the server
|
||||
description: JSON-parsed response from the server.
|
||||
returned: always
|
||||
type: dict
|
||||
|
||||
error:
|
||||
description: the error message returned by the GitLab API
|
||||
description: The error message returned by the GitLab API.
|
||||
returned: failed
|
||||
type: str
|
||||
sample: "400: path is already in use"
|
||||
|
||||
group:
|
||||
description: API object
|
||||
description: API object.
|
||||
returned: always
|
||||
type: dict
|
||||
'''
|
||||
"""
|
||||
|
||||
from ansible.module_utils.api import basic_auth_argument_spec
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue