ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-22 04:40:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Use semantic markup (modules m-n) (#6679)

Browse source 
* Use semantic markup.

* Use option instead of alias.

* Simplify.

* Fix/improve nagios docs.
This commit is contained in:
Felix Fontein 2023-06-15 15:47:40 +02:00 • committed by GitHub
commit b271dba4bf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
24 changed files with 263 additions and 259 deletions
Download patch file Download diff file Expand all files Collapse all files

10
plugins/modules/mattermost.py
View file

@ -39,26 +39,26 @@ options:
description:
- Mattermost webhook api key. Log into your mattermost site, go to
Menu -> Integration -> Incoming Webhook -> Add Incoming Webhook.
This will give you full URL. api_key is the last part.
This will give you full URL. I(api_key) is the last part.
http://mattermost.example.com/hooks/C(API_KEY)
required: true
text:
type: str
description:
- Text to send. Note that the module does not handle escaping characters.
- Required when I(attachments) is not set.
- Required when O(attachments) is not set.
attachments:
type: list
elements: dict
description:
- Define a list of attachments.
- For more information, see U(https://developers.mattermost.com/integrate/admin-guide/admin-message-attachments/).
- Required when I(text) is not set.
- Required when O(text) is not set.
version_added: 4.3.0
channel:
type: str
description:
- Channel to send the message to. If absent, the message goes to the channel selected for the I(api_key).
- Channel to send the message to. If absent, the message goes to the channel selected for the O(api_key).
username:
type: str
description:
@ -71,7 +71,7 @@ options:
default: https://docs.ansible.com/favicon.ico
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.
default: true
type: bool