mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-13 03:44: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
|
@ -32,83 +32,53 @@ options:
|
|||
description:
|
||||
- Create a maintenance window or get a list of ongoing windows.
|
||||
required: true
|
||||
default: null
|
||||
choices: [ "running", "started", "ongoing", "absent" ]
|
||||
aliases: []
|
||||
name:
|
||||
description:
|
||||
- PagerDuty unique subdomain.
|
||||
required: true
|
||||
default: null
|
||||
choices: []
|
||||
aliases: []
|
||||
user:
|
||||
description:
|
||||
- PagerDuty user ID.
|
||||
required: true
|
||||
default: null
|
||||
choices: []
|
||||
aliases: []
|
||||
passwd:
|
||||
description:
|
||||
- PagerDuty user password.
|
||||
required: true
|
||||
default: null
|
||||
choices: []
|
||||
aliases: []
|
||||
token:
|
||||
description:
|
||||
- A pagerduty token, generated on the pagerduty site. Can be used instead of
|
||||
user/passwd combination.
|
||||
required: true
|
||||
default: null
|
||||
choices: []
|
||||
aliases: []
|
||||
version_added: '1.8'
|
||||
requester_id:
|
||||
description:
|
||||
- ID of user making the request. Only needed when using a token and creating a maintenance_window.
|
||||
required: true
|
||||
default: null
|
||||
choices: []
|
||||
aliases: []
|
||||
version_added: '1.8'
|
||||
service:
|
||||
description:
|
||||
- A comma separated list of PagerDuty service IDs.
|
||||
required: false
|
||||
default: null
|
||||
choices: []
|
||||
aliases: [ services ]
|
||||
hours:
|
||||
description:
|
||||
- Length of maintenance window in hours.
|
||||
required: false
|
||||
default: 1
|
||||
choices: []
|
||||
aliases: []
|
||||
minutes:
|
||||
description:
|
||||
- Maintenance window in minutes (this is added to the hours).
|
||||
required: false
|
||||
default: 0
|
||||
choices: []
|
||||
aliases: []
|
||||
version_added: '1.8'
|
||||
desc:
|
||||
description:
|
||||
- Short description of maintenance window.
|
||||
required: false
|
||||
default: Created by Ansible
|
||||
choices: []
|
||||
aliases: []
|
||||
validate_certs:
|
||||
description:
|
||||
- If C(no), SSL certificates will not be validated. This should only be used
|
||||
on personally controlled sites using self-signed certificates.
|
||||
required: false
|
||||
type: bool
|
||||
default: 'yes'
|
||||
choices: ['yes', 'no']
|
||||
version_added: 1.5.1
|
||||
'''
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue