From 0c4d8a9ce59bafb23f0b354f16c8f2ea10f1fa1c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Moser?= Date: Wed, 7 Mar 2018 14:39:36 +0100 Subject: [PATCH] cloudstack: fix common E324 in docs (#37082) (#37119) Notes about precedence of common args. (partly cherry picked from commit 2559e832dfdd06086489a4905789ca0d10bcadf2) --- .../utils/module_docs_fragments/cloudstack.py | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/lib/ansible/utils/module_docs_fragments/cloudstack.py b/lib/ansible/utils/module_docs_fragments/cloudstack.py index 2df3f678942..dbcd67a4841 100644 --- a/lib/ansible/utils/module_docs_fragments/cloudstack.py +++ b/lib/ansible/utils/module_docs_fragments/cloudstack.py @@ -11,24 +11,35 @@ options: api_key: description: - API key of the CloudStack API. + - If not given, the C(CLOUDSTACK_KEY) env variable is considered. + - As the last option, the value is taken from the ini config file, also see the notes. api_secret: description: - Secret key of the CloudStack API. + - If not set, the C(CLOUDSTACK_SECRET) env variable is considered. + - As the last option, the value is taken from the ini config file, also see the notes. api_url: description: - URL of the CloudStack API e.g. https://cloud.example.com/client/api. + - If not given, the C(CLOUDSTACK_ENDPOINT) env variable is considered. + - As the last option, the value is taken from the ini config file, also see the notes. api_http_method: description: - - HTTP method used. - default: get + - HTTP method used to query the API endpoint. + - If not given, the C(CLOUDSTACK_METHOD) env variable is considered. + - As the last option, the value is taken from the ini config file, also see the notes. + - Fallback value is C(get) if not specified. choices: [ get, post ] api_timeout: description: - - HTTP timeout. - default: 10 + - HTTP timeout in seconds. + - If not given, the C(CLOUDSTACK_TIMEOUT) env variable is considered. + - As the last option, the value is taken from the ini config file, also see the notes. + - Fallback value is 10 seconds if not specified. api_region: description: - Name of the ini section in the C(cloustack.ini) file. + - If not given, the C(CLOUDSTACK_REGION) env variable is considered. default: cloudstack requirements: - "python >= 2.6"