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:
Dag Wieers 2018-03-15 22:15:24 +01:00 committed by GitHub
commit cdd21e2170
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
624 changed files with 1458 additions and 9114 deletions

View file

@ -27,43 +27,30 @@ options:
name:
description:
- The name of the alert policy. This is mutually exclusive with id
required: False
default: None
id:
description:
- The alert policy id. This is mutually exclusive with name
required: False
default: None
alert_recipients:
description:
- A list of recipient email ids to notify the alert.
This is required for state 'present'
required: False
default: None
metric:
description:
- The metric on which to measure the condition that will trigger the alert.
This is required for state 'present'
required: False
default: None
choices: ['cpu','memory','disk']
duration:
description:
- The length of time in minutes that the condition must exceed the threshold.
This is required for state 'present'
required: False
default: None
threshold:
description:
- The threshold that will trigger the alert when the metric equals or exceeds it.
This is required for state 'present'
This number represents a percentage and must be a value between 5.0 - 95.0 that is a multiple of 5.0
required: False
default: None
state:
description:
- Whether to create or delete the policy.
required: False
default: present
choices: ['present','absent']
requirements: