From 2559e832dfdd06086489a4905789ca0d10bcadf2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Moser?= Date: Wed, 7 Mar 2018 11:09:08 +0100 Subject: [PATCH] cloudstack: fix common E324 in docs (#37082) Notes about precedence of common args. Partly fixes E324. --- .../utils/module_docs_fragments/cloudstack.py | 19 +++++++-- test/sanity/validate-modules/ignore.txt | 40 ------------------- 2 files changed, 15 insertions(+), 44 deletions(-) diff --git a/lib/ansible/utils/module_docs_fragments/cloudstack.py b/lib/ansible/utils/module_docs_fragments/cloudstack.py index 2df3f67894..dbcd67a484 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" diff --git a/test/sanity/validate-modules/ignore.txt b/test/sanity/validate-modules/ignore.txt index c76a9d5856..a40bf3532f 100644 --- a/test/sanity/validate-modules/ignore.txt +++ b/test/sanity/validate-modules/ignore.txt @@ -359,34 +359,20 @@ lib/ansible/modules/cloud/centurylink/clc_server.py E325 lib/ansible/modules/cloud/centurylink/clc_server.py E326 lib/ansible/modules/cloud/centurylink/clc_server_snapshot.py E326 lib/ansible/modules/cloud/cloudscale/cloudscale_server.py E325 -lib/ansible/modules/cloud/cloudstack/_cs_nic.py E324 -lib/ansible/modules/cloud/cloudstack/cs_account.py E324 lib/ansible/modules/cloud/cloudstack/cs_account.py E325 -lib/ansible/modules/cloud/cloudstack/cs_affinitygroup.py E324 lib/ansible/modules/cloud/cloudstack/cs_affinitygroup.py E325 -lib/ansible/modules/cloud/cloudstack/cs_cluster.py E324 lib/ansible/modules/cloud/cloudstack/cs_cluster.py E326 -lib/ansible/modules/cloud/cloudstack/cs_configuration.py E324 -lib/ansible/modules/cloud/cloudstack/cs_domain.py E324 lib/ansible/modules/cloud/cloudstack/cs_domain.py E325 -lib/ansible/modules/cloud/cloudstack/cs_firewall.py E324 -lib/ansible/modules/cloud/cloudstack/cs_host.py E324 lib/ansible/modules/cloud/cloudstack/cs_host.py E326 -lib/ansible/modules/cloud/cloudstack/cs_instance.py E324 lib/ansible/modules/cloud/cloudstack/cs_instance.py E325 lib/ansible/modules/cloud/cloudstack/cs_instance.py E326 -lib/ansible/modules/cloud/cloudstack/cs_instance_facts.py E324 -lib/ansible/modules/cloud/cloudstack/cs_instance_nic.py E324 lib/ansible/modules/cloud/cloudstack/cs_instance_nic.py E325 -lib/ansible/modules/cloud/cloudstack/cs_instance_nic_secondaryip.py E324 lib/ansible/modules/cloud/cloudstack/cs_instance_nic_secondaryip.py E325 -lib/ansible/modules/cloud/cloudstack/cs_instancegroup.py E324 lib/ansible/modules/cloud/cloudstack/cs_ip_address.py E322 lib/ansible/modules/cloud/cloudstack/cs_ip_address.py E324 lib/ansible/modules/cloud/cloudstack/cs_ip_address.py E325 lib/ansible/modules/cloud/cloudstack/cs_ip_address.py E326 lib/ansible/modules/cloud/cloudstack/cs_iso.py E323 -lib/ansible/modules/cloud/cloudstack/cs_iso.py E324 lib/ansible/modules/cloud/cloudstack/cs_iso.py E325 lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule.py E322 lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule.py E324 @@ -394,70 +380,44 @@ lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule.py E325 lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule_member.py E322 lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule_member.py E324 lib/ansible/modules/cloud/cloudstack/cs_loadbalancer_rule_member.py E325 -lib/ansible/modules/cloud/cloudstack/cs_network.py E324 -lib/ansible/modules/cloud/cloudstack/cs_network_acl.py E324 lib/ansible/modules/cloud/cloudstack/cs_network_acl.py E325 lib/ansible/modules/cloud/cloudstack/cs_network_acl_rule.py E324 lib/ansible/modules/cloud/cloudstack/cs_network_acl_rule.py E325 lib/ansible/modules/cloud/cloudstack/cs_network_acl_rule.py E326 lib/ansible/modules/cloud/cloudstack/cs_network_offering.py E322 -lib/ansible/modules/cloud/cloudstack/cs_network_offering.py E324 lib/ansible/modules/cloud/cloudstack/cs_network_offering.py E325 lib/ansible/modules/cloud/cloudstack/cs_network_offering.py E326 -lib/ansible/modules/cloud/cloudstack/cs_pod.py E324 -lib/ansible/modules/cloud/cloudstack/cs_portforward.py E324 lib/ansible/modules/cloud/cloudstack/cs_portforward.py E325 lib/ansible/modules/cloud/cloudstack/cs_project.py E322 -lib/ansible/modules/cloud/cloudstack/cs_project.py E324 lib/ansible/modules/cloud/cloudstack/cs_project.py E325 -lib/ansible/modules/cloud/cloudstack/cs_region.py E324 -lib/ansible/modules/cloud/cloudstack/cs_resourcelimit.py E324 -lib/ansible/modules/cloud/cloudstack/cs_role.py E324 lib/ansible/modules/cloud/cloudstack/cs_router.py E322 lib/ansible/modules/cloud/cloudstack/cs_router.py E324 lib/ansible/modules/cloud/cloudstack/cs_router.py E325 -lib/ansible/modules/cloud/cloudstack/cs_securitygroup.py E324 -lib/ansible/modules/cloud/cloudstack/cs_securitygroup_rule.py E324 lib/ansible/modules/cloud/cloudstack/cs_securitygroup_rule.py E325 lib/ansible/modules/cloud/cloudstack/cs_service_offering.py E322 lib/ansible/modules/cloud/cloudstack/cs_service_offering.py E323 -lib/ansible/modules/cloud/cloudstack/cs_service_offering.py E324 lib/ansible/modules/cloud/cloudstack/cs_service_offering.py E325 lib/ansible/modules/cloud/cloudstack/cs_service_offering.py E326 -lib/ansible/modules/cloud/cloudstack/cs_snapshot_policy.py E324 -lib/ansible/modules/cloud/cloudstack/cs_sshkeypair.py E324 -lib/ansible/modules/cloud/cloudstack/cs_staticnat.py E324 lib/ansible/modules/cloud/cloudstack/cs_staticnat.py E325 lib/ansible/modules/cloud/cloudstack/cs_storage_pool.py E322 -lib/ansible/modules/cloud/cloudstack/cs_storage_pool.py E324 lib/ansible/modules/cloud/cloudstack/cs_storage_pool.py E325 lib/ansible/modules/cloud/cloudstack/cs_storage_pool.py E326 lib/ansible/modules/cloud/cloudstack/cs_template.py E324 lib/ansible/modules/cloud/cloudstack/cs_template.py E325 lib/ansible/modules/cloud/cloudstack/cs_template.py E326 -lib/ansible/modules/cloud/cloudstack/cs_user.py E324 lib/ansible/modules/cloud/cloudstack/cs_user.py E325 -lib/ansible/modules/cloud/cloudstack/cs_vmsnapshot.py E324 lib/ansible/modules/cloud/cloudstack/cs_vmsnapshot.py E325 lib/ansible/modules/cloud/cloudstack/cs_volume.py E322 -lib/ansible/modules/cloud/cloudstack/cs_volume.py E324 lib/ansible/modules/cloud/cloudstack/cs_volume.py E325 -lib/ansible/modules/cloud/cloudstack/cs_vpc.py E324 lib/ansible/modules/cloud/cloudstack/cs_vpc.py E325 -lib/ansible/modules/cloud/cloudstack/cs_vpc_offering.py E324 lib/ansible/modules/cloud/cloudstack/cs_vpc_offering.py E325 lib/ansible/modules/cloud/cloudstack/cs_vpn_connection.py E322 -lib/ansible/modules/cloud/cloudstack/cs_vpn_connection.py E324 -lib/ansible/modules/cloud/cloudstack/cs_vpn_customer_gateway.py E324 lib/ansible/modules/cloud/cloudstack/cs_vpn_customer_gateway.py E325 lib/ansible/modules/cloud/cloudstack/cs_vpn_customer_gateway.py E326 -lib/ansible/modules/cloud/cloudstack/cs_vpn_gateway.py E324 lib/ansible/modules/cloud/cloudstack/cs_vpn_gateway.py E325 lib/ansible/modules/cloud/cloudstack/cs_zone.py E322 -lib/ansible/modules/cloud/cloudstack/cs_zone.py E324 lib/ansible/modules/cloud/cloudstack/cs_zone.py E325 lib/ansible/modules/cloud/cloudstack/cs_zone.py E326 -lib/ansible/modules/cloud/cloudstack/cs_zone_facts.py E324 lib/ansible/modules/cloud/digital_ocean/digital_ocean.py E322 lib/ansible/modules/cloud/digital_ocean/digital_ocean.py E324 lib/ansible/modules/cloud/digital_ocean/digital_ocean.py E325