1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Mattermost: Add sending of attachments (#3946)

* Add sending of attachments

* Change required arguments and add changelog

- text was still default -> changed to required_one_of text or attachments
- Add version_added
- Add changelog fragment for mattermost attachments

Co-Authored-By: Felix Fontein <felix@fontein.de>

* Fix wrong indentation

* Add trailing comma

Co-authored-by: Felix Fontein <felix@fontein.de>

* Remove default=None

Co-authored-by: Felix Fontein <felix@fontein.de>

* Fix sentence

Co-authored-by: Felix Fontein <felix@fontein.de>

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
xobtoor 2022-01-03 19:24:12 +01:00 committed by GitHub
parent a4ab85fd68
commit 87ae203a7d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 34 additions and 4 deletions

View file

@ -0,0 +1,2 @@
minor_changes:
- mattermost - add the possibility to send attachments instead of text messages (https://github.com/ansible-collections/community.general/pull/3946).

View file

@ -38,7 +38,15 @@ options:
type: str type: str
description: description:
- Text to send. Note that the module does not handle escaping characters. - Text to send. Note that the module does not handle escaping characters.
required: true - Required when I(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.
version_added: 4.3.0
channel: channel:
type: str type: str
description: description:
@ -76,6 +84,22 @@ EXAMPLES = """
channel: notifications channel: notifications
username: 'Ansible on {{ inventory_hostname }}' username: 'Ansible on {{ inventory_hostname }}'
icon_url: http://www.example.com/some-image-file.png icon_url: http://www.example.com/some-image-file.png
- name: Send attachments message via Mattermost
community.general.mattermost:
url: http://mattermost.example.com
api_key: my_api_key
attachments:
- text: Display my system load on host A and B
color: '#ff00dd'
title: System load
fields:
- title: System A
value: "load average: 0,74, 0,66, 0,63"
short: True
- title: System B
value: 'load average: 5,16, 4,64, 2,43'
short: True
""" """
RETURN = ''' RETURN = '''
@ -99,12 +123,16 @@ def main():
argument_spec=dict( argument_spec=dict(
url=dict(type='str', required=True), url=dict(type='str', required=True),
api_key=dict(type='str', required=True, no_log=True), api_key=dict(type='str', required=True, no_log=True),
text=dict(type='str', required=True), text=dict(type='str'),
channel=dict(type='str', default=None), channel=dict(type='str', default=None),
username=dict(type='str', default='Ansible'), username=dict(type='str', default='Ansible'),
icon_url=dict(type='str', default='https://www.ansible.com/favicon.ico'), icon_url=dict(type='str', default='https://www.ansible.com/favicon.ico'),
validate_certs=dict(default=True, type='bool'), validate_certs=dict(default=True, type='bool'),
) attachments=dict(type='list', elements='dict'),
),
required_one_of=[
('text', 'attachments'),
],
) )
# init return dict # init return dict
result = dict(changed=False, msg="OK") result = dict(changed=False, msg="OK")
@ -115,7 +143,7 @@ def main():
# define payload # define payload
payload = {} payload = {}
for param in ['text', 'channel', 'username', 'icon_url']: for param in ['text', 'channel', 'username', 'icon_url', 'attachments']:
if module.params[param] is not None: if module.params[param] is not None:
payload[param] = module.params[param] payload[param] = module.params[param]