mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-24 19:31:26 -07:00
scaleway: Create a base class for all the modules
Purpose of this commit is to create a base class for the upcoming scaleway module to use. Co-authored-by: Rémy Leone <rleone@online.net>
This commit is contained in:
parent
62ec0409e5
commit
29cfebe332
2 changed files with 98 additions and 5 deletions
|
@ -8,14 +8,20 @@ class ModuleDocFragment(object):
|
|||
# Standard documentation fragment
|
||||
DOCUMENTATION = '''
|
||||
options:
|
||||
oauth_token:
|
||||
api_token:
|
||||
description:
|
||||
- Scaleway OAuth token.
|
||||
aliases: ['api_token']
|
||||
timeout:
|
||||
aliases: ['oauth_token']
|
||||
api_url:
|
||||
description:
|
||||
- Scaleway API URL
|
||||
default: 'https://api.scaleway.com'
|
||||
aliases: ['base_url']
|
||||
api_timeout:
|
||||
description:
|
||||
- HTTP timeout to Scaleway API in seconds.
|
||||
default: 30
|
||||
aliases: ['timeout']
|
||||
validate_certs:
|
||||
description:
|
||||
- Validate SSL certs of the Scaleway API.
|
||||
|
@ -23,7 +29,9 @@ options:
|
|||
type: bool
|
||||
notes:
|
||||
- Also see the API documentation on U(https://developer.scaleway.com/)
|
||||
- If parameters are not set within the module, the following
|
||||
- If C(api_token) is not set within the module, the following
|
||||
environment variables can be used in decreasing order of precedence
|
||||
C(SCW_TOKEN), C(SCW_API_KEY) or C(SCW_OAUTH_TOKEN).
|
||||
C(SCW_TOKEN), C(SCW_API_KEY), C(SCW_OAUTH_TOKEN) or C(SCW_API_TOKEN).
|
||||
- If one wants to use a different C(api_url) one can also set the C(SCW_API_URL)
|
||||
environment variable.
|
||||
'''
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue