mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-06 16:34:02 -07:00
Clean up module documentation (#36909)
* Clean up module documentation This PR includes: - Removal of `default: None` (and variations) - Removal of `required: false` - Fixing booleans and `type: bool` where required * Fix remaining (new) validation issues
This commit is contained in:
parent
58eb2e849d
commit
cdd21e2170
624 changed files with 1458 additions and 9114 deletions
|
@ -33,13 +33,11 @@ options:
|
|||
location:
|
||||
description:
|
||||
- The geo-locations in which the resource group will be located.
|
||||
required: false
|
||||
default: westus
|
||||
deployment_mode:
|
||||
description:
|
||||
- In incremental mode, resources are deployed without deleting existing resources that are not included in the template.
|
||||
In complete mode resources are deployed and existing resources in the resource group not included in the template are deleted.
|
||||
required: false
|
||||
default: incremental
|
||||
choices:
|
||||
- complete
|
||||
|
@ -49,7 +47,6 @@ options:
|
|||
- If state is "present", template will be created. If state is "present" and if deployment exists, it will be
|
||||
updated. If state is "absent", stack will be removed.
|
||||
default: present
|
||||
required: false
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
|
@ -57,26 +54,18 @@ options:
|
|||
description:
|
||||
- A hash containing the templates inline. This parameter is mutually exclusive with 'template_link'.
|
||||
Either one of them is required if "state" parameter is "present".
|
||||
required: false
|
||||
default: null
|
||||
template_link:
|
||||
description:
|
||||
- Uri of file containing the template body. This parameter is mutually exclusive with 'template'. Either one
|
||||
of them is required if "state" parameter is "present".
|
||||
required: false
|
||||
default: null
|
||||
parameters:
|
||||
description:
|
||||
- A hash of all the required template variables for the deployment template. This parameter is mutually exclusive
|
||||
with 'parameters_link'. Either one of them is required if "state" parameter is "present".
|
||||
required: false
|
||||
default: null
|
||||
parameters_link:
|
||||
description:
|
||||
- Uri of file containing the parameters body. This parameter is mutually exclusive with 'parameters'. Either
|
||||
one of them is required if "state" parameter is "present".
|
||||
required: false
|
||||
default: null
|
||||
deployment_name:
|
||||
description:
|
||||
- The name of the deployment to be tracked in the resource group deployment history. Re-using a deployment name
|
||||
|
@ -85,8 +74,8 @@ options:
|
|||
wait_for_deployment_completion:
|
||||
description:
|
||||
- Whether or not to block until the deployment has completed.
|
||||
default: yes
|
||||
choices: ['yes', 'no']
|
||||
type: bool
|
||||
default: 'yes'
|
||||
wait_for_deployment_polling_period:
|
||||
description:
|
||||
- Time (in seconds) to wait between polls when waiting for deployment completion.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue