mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-04-23 20:29: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.
43 lines
1.6 KiB
Python
43 lines
1.6 KiB
Python
# Copyright (c) 2019, Evgeniy Krysanov <evgeniy.krysanov@gmail.com>
|
|
# 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 documentation fragment
|
|
DOCUMENTATION = r"""
|
|
options:
|
|
client_id:
|
|
description:
|
|
- The OAuth consumer key.
|
|
- If not set the environment variable E(BITBUCKET_CLIENT_ID) is used.
|
|
type: str
|
|
client_secret:
|
|
description:
|
|
- The OAuth consumer secret.
|
|
- If not set the environment variable E(BITBUCKET_CLIENT_SECRET) is used.
|
|
type: str
|
|
user:
|
|
description:
|
|
- The username.
|
|
- If not set the environment variable E(BITBUCKET_USERNAME) is used.
|
|
- O(ignore:username) is an alias of O(user) since community.general 6.0.0. It was an alias of O(workspace) before.
|
|
type: str
|
|
version_added: 4.0.0
|
|
aliases: [username]
|
|
password:
|
|
description:
|
|
- The App password.
|
|
- If not set the environment variable E(BITBUCKET_PASSWORD) is used.
|
|
type: str
|
|
version_added: 4.0.0
|
|
notes:
|
|
- Bitbucket OAuth consumer key and secret can be obtained from Bitbucket profile -> Settings -> Access Management -> OAuth.
|
|
- Bitbucket App password can be created from Bitbucket profile -> Personal Settings -> App passwords.
|
|
- If both OAuth and Basic Auth credentials are passed, OAuth credentials take precedence.
|
|
"""
|