mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-04-21 00:01:08 +00:00
4fa82b9617
* Make all doc fragments private. * Make all plugin utils private. * Make all module utils private. * Reformat. * Changelog fragment. * Update configs and ignores. * Adjust unit test names.
33 lines
970 B
Python
33 lines
970 B
Python
# Copyright (c) Ansible project
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
# Note that this doc fragment is **PRIVATE** to the collection. It can have breaking changes at any time.
|
|
# Do not use this from other collections or standalone plugins/modules!
|
|
|
|
from __future__ import annotations
|
|
|
|
|
|
class ModuleDocFragment:
|
|
# Standard files documentation fragment
|
|
DOCUMENTATION = r"""
|
|
options:
|
|
api_url:
|
|
description:
|
|
- The resolvable endpoint for the API.
|
|
type: str
|
|
api_username:
|
|
description:
|
|
- The username to use for authentication against the API.
|
|
type: str
|
|
api_password:
|
|
description:
|
|
- The password to use for authentication against the API.
|
|
type: str
|
|
validate_certs:
|
|
description:
|
|
- Whether or not to validate SSL certs when supplying a HTTPS endpoint.
|
|
type: bool
|
|
default: true
|
|
"""
|