[pi ... prof]*: normalize docs (#9371)

* [pi ... prof]*: normalize docs

* Update plugins/modules/pkg5_publisher.py

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Alexei Znamensky 2024-12-26 10:48:04 +13:00 committed by GitHub
parent 23d97fa4b0
commit 13e2097f37
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
23 changed files with 702 additions and 766 deletions

View file

@ -8,54 +8,47 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = """
---
DOCUMENTATION = r"""
module: pritunl_org
author: Florian Dambrine (@Lowess)
version_added: 2.5.0
short_description: Manages Pritunl Organizations using the Pritunl API
description:
- A module to manage Pritunl organizations using the Pritunl API.
- A module to manage Pritunl organizations using the Pritunl API.
extends_documentation_fragment:
- community.general.pritunl
- community.general.attributes
- community.general.pritunl
- community.general.attributes
attributes:
check_mode:
support: none
diff_mode:
support: none
check_mode:
support: none
diff_mode:
support: none
options:
name:
type: str
required: true
aliases:
- org
description:
- The name of the organization to manage in Pritunl.
force:
type: bool
default: false
description:
- If O(force) is V(true) and O(state) is V(absent), the module
will delete the organization, no matter if it contains users
or not. By default O(force) is V(false), which will cause the
module to fail the deletion of the organization when it contains
users.
state:
type: str
default: 'present'
choices:
- present
- absent
description:
- If V(present), the module adds organization O(name) to
Pritunl. If V(absent), attempt to delete the organization
from Pritunl (please read about O(force) usage).
name:
type: str
required: true
aliases:
- org
description:
- The name of the organization to manage in Pritunl.
force:
type: bool
default: false
description:
- If O(force) is V(true) and O(state) is V(absent), the module will delete the organization, no matter if it contains users or not. By default
O(force) is V(false), which will cause the module to fail the deletion of the organization when it contains users.
state:
type: str
default: 'present'
choices:
- present
- absent
description:
- If V(present), the module adds organization O(name) to Pritunl. If V(absent), attempt to delete the organization from Pritunl (please
read about O(force) usage).
"""
EXAMPLES = """
EXAMPLES = r"""
- name: Ensure the organization named MyOrg exists
community.general.pritunl_org:
state: present
@ -67,7 +60,7 @@ EXAMPLES = """
name: MyOrg
"""
RETURN = """
RETURN = r"""
response:
description: JSON representation of a Pritunl Organization.
returned: success