mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 20:01:25 -07:00
doc_fragments: Clean up parameter types (cloud) (#52177)
* module_utils: Clean up parameter types (cloud) This PR includes: - Parameter types added - Copyright format fixes - Short license statement - Description fixes (only for a few files, then I stopped :-)) * More cloud stuff * Fix reported issue * Fix quotes * Use correct type * Fix quotes * Fix quotes * Fix quotes * Fix typo * Fix boolean
This commit is contained in:
parent
203caf2570
commit
25323155d2
28 changed files with 337 additions and 412 deletions
|
@ -1,37 +1,41 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
# Copyright (C) 2018 Yanis Guenane <yanis+ansible@guenane.org>
|
||||
|
||||
# Copyright: (c) 2018, Yanis Guenane <yanis+ansible@guenane.org>
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
|
||||
class ModuleDocFragment(object):
|
||||
|
||||
# Standard documentation fragment
|
||||
DOCUMENTATION = '''
|
||||
DOCUMENTATION = r'''
|
||||
options:
|
||||
api_token:
|
||||
description:
|
||||
- Scaleway OAuth token.
|
||||
aliases: ['oauth_token']
|
||||
type: str
|
||||
aliases: [ oauth_token ]
|
||||
api_url:
|
||||
description:
|
||||
- Scaleway API URL
|
||||
default: 'https://api.scaleway.com'
|
||||
aliases: ['base_url']
|
||||
- Scaleway API URL.
|
||||
type: str
|
||||
default: https://api.scaleway.com
|
||||
aliases: [ base_url ]
|
||||
api_timeout:
|
||||
description:
|
||||
- HTTP timeout to Scaleway API in seconds.
|
||||
type: int
|
||||
default: 30
|
||||
aliases: ['timeout']
|
||||
aliases: [ timeout ]
|
||||
query_parameters:
|
||||
description:
|
||||
- List of parameters passed to the query string
|
||||
- List of parameters passed to the query string.
|
||||
type: dict
|
||||
default: {}
|
||||
validate_certs:
|
||||
description:
|
||||
- Validate SSL certs of the Scaleway API.
|
||||
default: yes
|
||||
type: bool
|
||||
default: yes
|
||||
notes:
|
||||
- Also see the API documentation on U(https://developer.scaleway.com/)
|
||||
- If C(api_token) is not set within the module, the following
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue