diff options
author | John R Barker <john@johnrbarker.com> | 2018-01-16 12:18:51 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-01-16 12:18:51 +0000 |
commit | 195beebcb4d25eeb32dfe251cb4993a99e865982 (patch) | |
tree | 28754d9962332adfc8b6e5551409165ec725b872 /lib/ansible/modules/cloud/digital_ocean | |
parent | c386ae9498ad6bf0c5b85a993fe1bc3ebc38ec59 (diff) | |
download | ansible-195beebcb4d25eeb32dfe251cb4993a99e865982.tar.gz |
Module DOCUMENTATION should match argspec (#34895)
* Module DOCUMENTATION should match argspec
Large update of many modules so that DOCUMENTATION option name and
aliases match those defined in the argspec.
Issues identified by https://github.com/ansible/ansible/pull/34809
In addition to many typos and missing aliases, the following notable
changes were made:
* Create `module_docs_fragments/url.py` for `url_argument_spec`
* `dellos*_command` shouldn't have ever had `waitfor` (was incorrectly copied)
* `ce_aaa_server_host.py` `s/raduis_server_type/radius_server_type/g`
* `Junos_lldp` enable should be part of `state`.
Diffstat (limited to 'lib/ansible/modules/cloud/digital_ocean')
5 files changed, 6 insertions, 1 deletions
diff --git a/lib/ansible/modules/cloud/digital_ocean/digital_ocean.py b/lib/ansible/modules/cloud/digital_ocean/digital_ocean.py index f3049eb848..6936aaaeff 100644 --- a/lib/ansible/modules/cloud/digital_ocean/digital_ocean.py +++ b/lib/ansible/modules/cloud/digital_ocean/digital_ocean.py @@ -39,6 +39,7 @@ options: id: description: - Numeric, the droplet id you want to operate on. + aliases: ['droplet_id'] name: description: - String, this is the name of the droplet - must be formatted by hostname rules, or the name of a SSH key. diff --git a/lib/ansible/modules/cloud/digital_ocean/digital_ocean_certificate.py b/lib/ansible/modules/cloud/digital_ocean/digital_ocean_certificate.py index ce17e3bf61..258d37fc11 100644 --- a/lib/ansible/modules/cloud/digital_ocean/digital_ocean_certificate.py +++ b/lib/ansible/modules/cloud/digital_ocean/digital_ocean_certificate.py @@ -43,6 +43,7 @@ options: description: - DigitalOcean OAuth token. required: true + aliases: ['DO_API_TOKEN', 'DO_API_KEY', 'DO_OAUTH_TOKEN'] notes: - Two environment variables can be used, DO_API_KEY, DO_OAUTH_TOKEN and DO_API_TOKEN. diff --git a/lib/ansible/modules/cloud/digital_ocean/digital_ocean_domain.py b/lib/ansible/modules/cloud/digital_ocean/digital_ocean_domain.py index 5568915c67..3e0f9017f1 100644 --- a/lib/ansible/modules/cloud/digital_ocean/digital_ocean_domain.py +++ b/lib/ansible/modules/cloud/digital_ocean/digital_ocean_domain.py @@ -31,10 +31,11 @@ options: description: - DigitalOcean api token. version_added: "1.9.5" - aliases: ['api_token'] + aliases: ['API_TOKEN'] id: description: - Numeric, the droplet id you want to operate on. + aliases: ['droplet_id'] name: description: - String, this is the name of the droplet - must be formatted by hostname rules, or the name of a SSH key, or the name of a domain. diff --git a/lib/ansible/modules/cloud/digital_ocean/digital_ocean_sshkey.py b/lib/ansible/modules/cloud/digital_ocean/digital_ocean_sshkey.py index 2fe1452f05..59a6c3ccda 100644 --- a/lib/ansible/modules/cloud/digital_ocean/digital_ocean_sshkey.py +++ b/lib/ansible/modules/cloud/digital_ocean/digital_ocean_sshkey.py @@ -33,6 +33,7 @@ options: required: false default: None version_added: 2.4 + aliases: ['id'] name: description: - The name for the SSH key diff --git a/lib/ansible/modules/cloud/digital_ocean/digital_ocean_tag.py b/lib/ansible/modules/cloud/digital_ocean/digital_ocean_tag.py index 5d314f35c4..30a318520c 100644 --- a/lib/ansible/modules/cloud/digital_ocean/digital_ocean_tag.py +++ b/lib/ansible/modules/cloud/digital_ocean/digital_ocean_tag.py @@ -31,6 +31,7 @@ options: description: - The ID of the resource to operate on. - The data type of resource_id is changed from integer to string, from version 2.5. + aliases: ['droplet_id'] resource_type: description: - The type of resource to operate on. Currently, only tagging of |