mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-08-22 22:11:44 -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
|
@ -28,13 +28,10 @@ version_added: "1.3"
|
|||
author:
|
||||
- "Artūras `arturaz` Šlajus (@arturaz)"
|
||||
- "Naoya Nakazawa (@n0ts)"
|
||||
notes: []
|
||||
requirements: []
|
||||
options:
|
||||
api_key:
|
||||
description: ["Your DataDog API key."]
|
||||
required: true
|
||||
default: null
|
||||
app_key:
|
||||
description: ["Your DataDog app key."]
|
||||
required: true
|
||||
|
@ -42,47 +39,36 @@ options:
|
|||
title:
|
||||
description: ["The event title."]
|
||||
required: true
|
||||
default: null
|
||||
text:
|
||||
description: ["The body of the event."]
|
||||
required: true
|
||||
default: null
|
||||
date_happened:
|
||||
description:
|
||||
- POSIX timestamp of the event.
|
||||
- Default value is now.
|
||||
required: false
|
||||
default: now
|
||||
priority:
|
||||
description: ["The priority of the event."]
|
||||
required: false
|
||||
default: normal
|
||||
choices: [normal, low]
|
||||
host:
|
||||
description: ["Host name to associate with the event."]
|
||||
required: false
|
||||
default: "{{ ansible_hostname }}"
|
||||
version_added: "2.4"
|
||||
tags:
|
||||
description: ["Comma separated list of tags to apply to the event."]
|
||||
required: false
|
||||
default: null
|
||||
alert_type:
|
||||
description: ["Type of alert."]
|
||||
required: false
|
||||
default: info
|
||||
choices: ['error', 'warning', 'info', 'success']
|
||||
aggregation_key:
|
||||
description: ["An arbitrary string to use for aggregation."]
|
||||
required: false
|
||||
default: null
|
||||
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