c*.py: normalize docs (#9418)

* c*.py: normalize docs

* fix copy/paste mistake

* Apply suggestions from code review

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

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Alexei Znamensky 2024-12-28 02:29:05 +13:00 committed by GitHub
parent 912065ad0e
commit 43599c6850
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
36 changed files with 1437 additions and 1614 deletions

View file

@ -11,14 +11,13 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: catapult
short_description: Send a sms / mms using the catapult bandwidth api
short_description: Send a sms / mms using the catapult bandwidth API
description:
- Allows notifications to be sent using sms / mms via the catapult bandwidth api.
- Allows notifications to be sent using SMS / MMS using the catapult bandwidth API.
extends_documentation_fragment:
- community.general.attributes
- community.general.attributes
attributes:
check_mode:
support: none
@ -44,31 +43,30 @@ options:
media:
type: str
description:
- For MMS messages, a media url to the location of the media to be sent with the message.
- For MMS messages, a media URL to the location of the media to be sent with the message.
user_id:
type: str
description:
- User Id from Api account page.
- User Id from API account page.
required: true
api_token:
type: str
description:
- Api Token from Api account page.
- API Token from API account page.
required: true
api_secret:
type: str
description:
- Api Secret from Api account page.
- API Secret from API account page.
required: true
author: "Jonathan Mainguy (@Jmainguy)"
notes:
- Will return changed even if the media url is wrong.
- Will return changed if the destination number is invalid.
- Will return changed even if the media url is wrong.
- Will return changed if the destination number is invalid.
"""
'''
EXAMPLES = '''
EXAMPLES = r"""
- name: Send a mms to multiple users
community.general.catapult:
src: "+15035555555"
@ -89,16 +87,15 @@ EXAMPLES = '''
user_id: "{{ user_id }}"
api_token: "{{ api_token }}"
api_secret: "{{ api_secret }}"
"""
'''
RETURN = '''
RETURN = r"""
changed:
description: Whether the api accepted the message.
returned: always
type: bool
sample: true
'''
description: Whether the API accepted the message.
returned: always
type: bool
sample: true
"""
import json