mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
online: Clean up parameter types (#52527)
This PR includes: - Parameter types added - Copyright format fixes - Short license statement This breaks out PR #52182
This commit is contained in:
parent
953d4c8a7f
commit
1d3eb0bafd
1 changed files with 9 additions and 5 deletions
|
@ -1,31 +1,35 @@
|
||||||
# -*- coding: utf-8 -*-
|
# -*- coding: utf-8 -*-
|
||||||
|
|
||||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||||
|
|
||||||
|
|
||||||
class ModuleDocFragment(object):
|
class ModuleDocFragment(object):
|
||||||
|
|
||||||
# Standard documentation fragment
|
# Standard documentation fragment
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = r'''
|
||||||
options:
|
options:
|
||||||
api_token:
|
api_token:
|
||||||
description:
|
description:
|
||||||
- Online OAuth token.
|
- Online OAuth token.
|
||||||
aliases: ['oauth_token']
|
type: str
|
||||||
|
aliases: [ oauth_token ]
|
||||||
api_url:
|
api_url:
|
||||||
description:
|
description:
|
||||||
- Online API URL
|
- Online API URL
|
||||||
|
type: str
|
||||||
default: 'https://api.online.net'
|
default: 'https://api.online.net'
|
||||||
aliases: ['base_url']
|
aliases: [ base_url ]
|
||||||
api_timeout:
|
api_timeout:
|
||||||
description:
|
description:
|
||||||
- HTTP timeout to Online API in seconds.
|
- HTTP timeout to Online API in seconds.
|
||||||
|
type: int
|
||||||
default: 30
|
default: 30
|
||||||
aliases: ['timeout']
|
aliases: [ timeout ]
|
||||||
validate_certs:
|
validate_certs:
|
||||||
description:
|
description:
|
||||||
- Validate SSL certs of the Online API.
|
- Validate SSL certs of the Online API.
|
||||||
default: yes
|
|
||||||
type: bool
|
type: bool
|
||||||
|
default: yes
|
||||||
notes:
|
notes:
|
||||||
- Also see the API documentation on U(https://console.online.net/en/api/)
|
- Also see the API documentation on U(https://console.online.net/en/api/)
|
||||||
- If C(api_token) is not set within the module, the following
|
- If C(api_token) is not set within the module, the following
|
||||||
|
|
Loading…
Reference in a new issue