From 1d3eb0bafd46f3e9cfb7d6395ad1a100052ff821 Mon Sep 17 00:00:00 2001 From: Dag Wieers Date: Tue, 19 Feb 2019 21:48:30 +0100 Subject: [PATCH] online: Clean up parameter types (#52527) This PR includes: - Parameter types added - Copyright format fixes - Short license statement This breaks out PR #52182 --- lib/ansible/plugins/doc_fragments/online.py | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/lib/ansible/plugins/doc_fragments/online.py b/lib/ansible/plugins/doc_fragments/online.py index b5303a2ef67..08a11da356d 100644 --- a/lib/ansible/plugins/doc_fragments/online.py +++ b/lib/ansible/plugins/doc_fragments/online.py @@ -1,31 +1,35 @@ # -*- coding: utf-8 -*- + # 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: - Online OAuth token. - aliases: ['oauth_token'] + type: str + aliases: [ oauth_token ] api_url: description: - Online API URL + type: str default: 'https://api.online.net' - aliases: ['base_url'] + aliases: [ base_url ] api_timeout: description: - HTTP timeout to Online API in seconds. + type: int default: 30 - aliases: ['timeout'] + aliases: [ timeout ] validate_certs: description: - Validate SSL certs of the Online API. - default: yes type: bool + default: yes notes: - 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