summaryrefslogtreecommitdiffstats
path: root/ansible_collections/community/general/plugins/modules/rocketchat.py
diff options
context:
space:
mode:
Diffstat (limited to 'ansible_collections/community/general/plugins/modules/rocketchat.py')
-rw-r--r--ansible_collections/community/general/plugins/modules/rocketchat.py16
1 files changed, 9 insertions, 7 deletions
diff --git a/ansible_collections/community/general/plugins/modules/rocketchat.py b/ansible_collections/community/general/plugins/modules/rocketchat.py
index 23d6d529e..473f0150a 100644
--- a/ansible_collections/community/general/plugins/modules/rocketchat.py
+++ b/ansible_collections/community/general/plugins/modules/rocketchat.py
@@ -29,8 +29,8 @@ options:
domain:
type: str
description:
- - The domain for your environment without protocol. (i.e.
- C(example.com) or C(chat.example.com))
+ - The domain for your environment without protocol. (For example
+ V(example.com) or V(chat.example.com).)
required: true
token:
type: str
@@ -42,7 +42,7 @@ options:
protocol:
type: str
description:
- - Specify the protocol used to send notification messages before the webhook url. (i.e. http or https)
+ - Specify the protocol used to send notification messages before the webhook URL (that is, V(http) or V(https)).
default: https
choices:
- 'http'
@@ -54,7 +54,7 @@ options:
channel:
type: str
description:
- - Channel to send the message to. If absent, the message goes to the channel selected for the I(token)
+ - Channel to send the message to. If absent, the message goes to the channel selected for the O(token)
specified during the creation of webhook.
username:
type: str
@@ -70,18 +70,20 @@ options:
type: str
description:
- Emoji for the message sender. The representation for the available emojis can be
- got from Rocket Chat. (for example :thumbsup:) (if I(icon_emoji) is set, I(icon_url) will not be used)
+ got from Rocket Chat.
+ - For example V(:thumbsup:).
+ - If O(icon_emoji) is set, O(icon_url) will not be used.
link_names:
type: int
description:
- - Automatically create links for channels and usernames in I(msg).
+ - Automatically create links for channels and usernames in O(msg).
default: 1
choices:
- 1
- 0
validate_certs:
description:
- - If C(false), SSL certificates will not be validated. This should only be used
+ - If V(false), SSL certificates will not be validated. This should only be used
on personally controlled sites using self-signed certificates.
type: bool
default: true