diff options
author | Dag Wieers <dag@wieers.com> | 2018-12-17 18:24:43 +0100 |
---|---|---|
committer | Alicia Cozine <879121+acozine@users.noreply.github.com> | 2018-12-17 11:24:43 -0600 |
commit | 00a83035f2c6c30235fe985dbd6e3b48e7c86ee7 (patch) | |
tree | 7b8a4d4093bbd33f31bfb81259fecdda2703c24a /lib/ansible/utils | |
parent | 0eb292438067f77a0318d57be648103f87c39a01 (diff) | |
download | ansible-00a83035f2c6c30235fe985dbd6e3b48e7c86ee7.tar.gz |
Meraki: Add types to common parameters (#49998)
Diffstat (limited to 'lib/ansible/utils')
-rw-r--r-- | lib/ansible/utils/module_docs_fragments/meraki.py | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/lib/ansible/utils/module_docs_fragments/meraki.py b/lib/ansible/utils/module_docs_fragments/meraki.py index e86469f99b..ea4ea44339 100644 --- a/lib/ansible/utils/module_docs_fragments/meraki.py +++ b/lib/ansible/utils/module_docs_fragments/meraki.py @@ -1,25 +1,25 @@ # -*- coding: utf-8 -*- # Copyright: (c) 2018, Kevin Breit (@kbreit) <kevin.breit@kevinbreit.net> - # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) class ModuleDocFragment(object): # Standard files for documentation fragment - DOCUMENTATION = ''' + DOCUMENTATION = r''' notes: - More information about the Meraki API can be found at U(https://dashboard.meraki.com/api_docs). -- Some of the options are likely only used for developers within Meraki +- Some of the options are likely only used for developers within Meraki. options: auth_key: description: - Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set. + type: str host: description: - - Hostname for Meraki dashboard - - Only useful for internal Meraki developers - type: string + - Hostname for Meraki dashboard. + - Only useful for internal Meraki developers. + type: str default: 'api.meraki.com' use_proxy: description: @@ -28,14 +28,15 @@ options: use_https: description: - If C(no), it will use HTTP. Otherwise it will use HTTPS. - - Only useful for internal Meraki developers + - Only useful for internal Meraki developers. type: bool default: 'yes' output_level: description: - Set amount of debug output during module execution - choices: ['normal', 'debug'] - default: 'normal' + type: str + choices: [ normal, debug ] + default: normal timeout: description: - Time to timeout for HTTP requests. @@ -49,8 +50,10 @@ options: org_name: description: - Name of organization. + type: str aliases: [ organization ] org_id: description: - ID of organization. + type: str ''' |