From 35a283918a58f3b5bdf80bb72d39ff899a3df16c Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Wed, 24 Aug 2022 19:59:46 +0200 Subject: [PATCH] Adjust booleans in notification modules. (#5157) --- plugins/modules/notification/bearychat.py | 6 +++--- plugins/modules/notification/cisco_webex.py | 8 ++++---- plugins/modules/notification/discord.py | 4 ++-- plugins/modules/notification/flowdock.py | 4 ++-- plugins/modules/notification/grove.py | 4 ++-- plugins/modules/notification/hipchat.py | 6 +++--- plugins/modules/notification/irc.py | 4 ++-- plugins/modules/notification/mail.py | 2 +- plugins/modules/notification/mattermost.py | 4 ++-- plugins/modules/notification/mqtt.py | 2 +- plugins/modules/notification/nexmo.py | 4 ++-- plugins/modules/notification/rocketchat.py | 4 ++-- plugins/modules/notification/sendgrid.py | 4 ++-- plugins/modules/notification/slack.py | 4 ++-- 14 files changed, 30 insertions(+), 30 deletions(-) diff --git a/plugins/modules/notification/bearychat.py b/plugins/modules/notification/bearychat.py index e66b736d75..48d5c994fc 100644 --- a/plugins/modules/notification/bearychat.py +++ b/plugins/modules/notification/bearychat.py @@ -28,8 +28,8 @@ options: - Message to send. markdown: description: - - If C(yes), text will be parsed as markdown. - default: 'yes' + - If C(true), text will be parsed as markdown. + default: true type: bool channel: type: str @@ -58,7 +58,7 @@ EXAMPLES = """ url: | https://hook.bearychat.com/=ae2CF/incoming/e61bd5c57b164e04b11ac02e66f47f60 text: "{{ inventory_hostname }} completed" - markdown: no + markdown: false channel: "#ansible" attachments: - title: "Ansible on {{ inventory_hostname }}" diff --git a/plugins/modules/notification/cisco_webex.py b/plugins/modules/notification/cisco_webex.py index 7bcae7fcfa..95fcccb7d6 100644 --- a/plugins/modules/notification/cisco_webex.py +++ b/plugins/modules/notification/cisco_webex.py @@ -26,14 +26,14 @@ options: description: - The request parameter you would like to send the message to. - Messages can be sent to either a room or individual (by ID or E-Mail). - required: yes + required: true choices: ['roomId', 'toPersonEmail', 'toPersonId'] type: str recipient_id: description: - The unique identifier associated with the supplied C(recipient_type). - required: yes + required: true type: str msg_type: @@ -47,14 +47,14 @@ options: personal_token: description: - Your personal access token required to validate the Webex Teams API. - required: yes + required: true aliases: ['token'] type: str msg: description: - The message you would like to send. - required: yes + required: true type: str ''' diff --git a/plugins/modules/notification/discord.py b/plugins/modules/notification/discord.py index d31448529c..9df00ad7dd 100644 --- a/plugins/modules/notification/discord.py +++ b/plugins/modules/notification/discord.py @@ -25,13 +25,13 @@ options: description: - The webhook ID. - "Format from Discord webhook URL: C(/webhooks/{webhook.id}/{webhook.token})." - required: yes + required: true type: str webhook_token: description: - The webhook token. - "Format from Discord webhook URL: C(/webhooks/{webhook.id}/{webhook.token})." - required: yes + required: true type: str content: description: diff --git a/plugins/modules/notification/flowdock.py b/plugins/modules/notification/flowdock.py index 880236b36b..965ae62d7a 100644 --- a/plugins/modules/notification/flowdock.py +++ b/plugins/modules/notification/flowdock.py @@ -80,10 +80,10 @@ options: required: false validate_certs: description: - - If C(no), SSL certificates will not be validated. This should only be used + - If C(false), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. required: false - default: 'yes' + default: true type: bool requirements: [ ] diff --git a/plugins/modules/notification/grove.py b/plugins/modules/notification/grove.py index 5cc65c0a65..d3ad6bb019 100644 --- a/plugins/modules/notification/grove.py +++ b/plugins/modules/notification/grove.py @@ -46,9 +46,9 @@ options: required: false validate_certs: description: - - If C(no), SSL certificates will not be validated. This should only be used + - If C(false), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. - default: 'yes' + default: true type: bool author: "Jonas Pfenniger (@zimbatm)" ''' diff --git a/plugins/modules/notification/hipchat.py b/plugins/modules/notification/hipchat.py index 7e1a2418ad..1871bd23ae 100644 --- a/plugins/modules/notification/hipchat.py +++ b/plugins/modules/notification/hipchat.py @@ -54,13 +54,13 @@ options: description: - If true, a notification will be triggered for users in the room. type: bool - default: 'yes' + default: true validate_certs: description: - - If C(no), SSL certificates will not be validated. This should only be used + - If C(false), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. type: bool - default: 'yes' + default: true api: type: str description: diff --git a/plugins/modules/notification/irc.py b/plugins/modules/notification/irc.py index b1bca89aaa..f45d610da7 100644 --- a/plugins/modules/notification/irc.py +++ b/plugins/modules/notification/irc.py @@ -76,13 +76,13 @@ options: description: - Designates whether TLS/SSL should be used when connecting to the IRC server type: bool - default: 'no' + default: false part: description: - Designates whether user should part from channel after sending message or not. Useful for when using a faux bot and not wanting join/parts between messages. type: bool - default: 'yes' + default: true style: type: str description: diff --git a/plugins/modules/notification/mail.py b/plugins/modules/notification/mail.py index 59206f4bb6..697ed49ee7 100644 --- a/plugins/modules/notification/mail.py +++ b/plugins/modules/notification/mail.py @@ -58,7 +58,7 @@ options: subject: description: - The subject of the email being sent. - required: yes + required: true type: str aliases: [ msg ] body: diff --git a/plugins/modules/notification/mattermost.py b/plugins/modules/notification/mattermost.py index c3ee910888..8f2f0b608f 100644 --- a/plugins/modules/notification/mattermost.py +++ b/plugins/modules/notification/mattermost.py @@ -64,9 +64,9 @@ options: default: https://www.ansible.com/favicon.ico validate_certs: description: - - If C(no), SSL certificates will not be validated. This should only be used + - If C(false), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. - default: yes + default: true type: bool ''' diff --git a/plugins/modules/notification/mqtt.py b/plugins/modules/notification/mqtt.py index 9e2712b2c1..81d2bf6a4f 100644 --- a/plugins/modules/notification/mqtt.py +++ b/plugins/modules/notification/mqtt.py @@ -63,7 +63,7 @@ options: applications that subsequently subscribe to the topic can received the last retained message immediately. type: bool - default: 'no' + default: false ca_cert: type: path description: diff --git a/plugins/modules/notification/nexmo.py b/plugins/modules/notification/nexmo.py index 103f366d2f..d1e6b8d35c 100644 --- a/plugins/modules/notification/nexmo.py +++ b/plugins/modules/notification/nexmo.py @@ -45,10 +45,10 @@ options: required: true validate_certs: description: - - If C(no), SSL certificates will not be validated. This should only be used + - If C(false), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. type: bool - default: 'yes' + default: true extends_documentation_fragment: - url ''' diff --git a/plugins/modules/notification/rocketchat.py b/plugins/modules/notification/rocketchat.py index ed7c35da78..affbb625e1 100644 --- a/plugins/modules/notification/rocketchat.py +++ b/plugins/modules/notification/rocketchat.py @@ -74,10 +74,10 @@ options: - 0 validate_certs: description: - - If C(no), SSL certificates will not be validated. This should only be used + - If C(false), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. type: bool - default: 'yes' + default: true color: type: str description: diff --git a/plugins/modules/notification/sendgrid.py b/plugins/modules/notification/sendgrid.py index 3424cf4194..d2a52e5f0e 100644 --- a/plugins/modules/notification/sendgrid.py +++ b/plugins/modules/notification/sendgrid.py @@ -81,7 +81,7 @@ options: description: - Whether the body is html content that should be rendered. type: bool - default: 'no' + default: false headers: type: dict description: @@ -90,7 +90,7 @@ options: type: str description: - The e-mail body content. - required: yes + required: true author: "Matt Makai (@makaimc)" ''' diff --git a/plugins/modules/notification/slack.py b/plugins/modules/notification/slack.py index eb5cf325f3..d985412932 100644 --- a/plugins/modules/notification/slack.py +++ b/plugins/modules/notification/slack.py @@ -104,10 +104,10 @@ options: - 'none' validate_certs: description: - - If C(no), SSL certificates will not be validated. This should only be used + - If C(false), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. type: bool - default: 'yes' + default: true color: type: str description: