Tidy up validate-modules ignores for notification modules (#1229) (#1232)

* fixed validation-modules for plugins/modules/notification/bearychat.py

* fixed validation-modules for plugins/modules/notification/campfire.py

* fixed validation-modules for plugins/modules/notification/catapult.py

* fixed validation-modules for plugins/modules/notification/flowdock.py

* fixed validation-modules for plugins/modules/notification/grove.py

* fixed validation-modules for plugins/modules/notification/hipchat.py

* fixed validation-modules for plugins/modules/notification/irc.py

* fixed validation-modules for plugins/modules/notification/jabber.py

* fixed validation-modules for plugins/modules/notification/logentries_msg.py

* fixed validation-modules for plugins/modules/notification/mail.py

* fixed validation-modules for plugins/modules/notification/matrix.py

* fixed validation-modules for plugins/modules/notification/mattermost.py

* fixed validation-modules for plugins/modules/notification/mqtt.py

* fixed validation-modules for plugins/modules/notification/nexmo.py

* fixed validation-modules for plugins/modules/notification/office_365_connector_card.py

* fixed some docs issues in plugins/modules/notification/pushbullet.py, but cannot remove the ignore lines yet

* fixed validation-modules for plugins/modules/notification/pushover.py

* fixed some docs issues in plugins/modules/notification/rocketchat.py, but cannot remove all ignore lines yet

* fixed validation-modules for plugins/modules/notification/say.py

* fixed validation-modules for plugins/modules/notification/sendgrid.py

* fixed validation-modules for plugins/modules/notification/slack.py

* fixed validation-modules for plugins/modules/notification/syslogger.py

* fixed validation-modules for plugins/modules/notification/telegram.py

* fixed validation-modules for plugins/modules/notification/twilio.py

* fixed validation-modules for plugins/modules/notification/typetalk.py

* Enabling validation-modules for modules in: notification

* removed naughty trailing space

(cherry picked from commit 24f780ec9a)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>

plugins/modules/notification/bearychat.py

@@ -30,12 +30,14 @@ description:
 author: "Jiangge Zhang (@tonyseek)"
 options:
   url:
+    type: str
     description:
       - BearyChat WebHook URL. This authenticates you to the bearychat
         service. It looks like
         C(https://hook.bearychat.com/=ae2CF/incoming/e61bd5c57b164e04b11ac02e66f47f60).
     required: true
   text:
+    type: str
     description:
       - Message to send.
   markdown:
@@ -44,10 +46,13 @@ options:
     default: 'yes'
     type: bool
   channel:
+    type: str
     description:
       - Channel to send the message to. If absent, the message goes to the
         default channel selected by the I(url).
   attachments:
+    type: list
+    elements: dict
     description:
       - Define a list of attachments. For more information, see
         https://github.com/bearyinnovative/bearychat-tutorial/blob/master/robots/incoming.md#attachments
@@ -154,7 +159,7 @@ def main():
         'text': dict(type='str'),
         'markdown': dict(default=True, type='bool'),
         'channel': dict(type='str'),
-        'attachments': dict(type='list'),
+        'attachments': dict(type='list', elements='dict'),
     })
 
     if not HAS_URLPARSE:

plugins/modules/notification/campfire.py

@@ -17,22 +17,27 @@ description:
    - Messages with newlines will result in a "Paste" message being sent.
 options:
   subscription:
+    type: str
     description:
       - The subscription name to use.
     required: true
   token:
+    type: str
     description:
       - API token.
     required: true
   room:
+    type: str
     description:
       - Room number to which the message should be sent.
     required: true
   msg:
+    type: str
     description:
       - The message body.
     required: true
   notify:
+    type: str
     description:
       - Send a notification sound before the message.
     required: false

plugins/modules/notification/catapult.py

@@ -18,29 +18,37 @@ description:
      - Allows notifications to be sent using sms / mms via the catapult bandwidth api.
 options:
   src:
+    type: str
     description:
       - One of your catapult telephone numbers the message should come from (must be in E.164 format, like C(+19195551212)).
     required: true
   dest:
+    type: list
+    elements: str
     description:
       - The phone number or numbers the message should be sent to (must be in E.164 format, like C(+19195551212)).
     required: true
   msg:
+    type: str
     description:
       - The contents of the text message (must be 2048 characters or less).
     required: true
   media:
+    type: str
     description:
       - 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.
     required: true
   api_token:
+    type: str
     description:
       - Api Token from Api account page.
     required: true
   api_secret:
+    type: str
     description:
       - Api Secret from Api account page.
     required: true
@@ -114,7 +122,7 @@ def main():
     module = AnsibleModule(
         argument_spec=dict(
             src=dict(required=True),
-            dest=dict(required=True, type='list'),
+            dest=dict(required=True, type='list', elements='str'),
             msg=dict(required=True),
             user_id=dict(required=True),
             api_token=dict(required=True, no_log=True),

plugins/modules/notification/flowdock.py

@@ -17,51 +17,63 @@ description:
    - Send a message to a flowdock team inbox or chat using the push API (see https://www.flowdock.com/api/team-inbox and https://www.flowdock.com/api/chat)
 options:
   token:
+    type: str
     description:
       - API token.
     required: true
   type:
+    type: str
     description:
       - Whether to post to 'inbox' or 'chat'
     required: true
     choices: [ "inbox", "chat" ]
   msg:
+    type: str
     description:
       - Content of the message
     required: true
   tags:
+    type: str
     description:
       - tags of the message, separated by commas
     required: false
   external_user_name:
+    type: str
     description:
       - (chat only - required) Name of the "user" sending the message
     required: false
   from_address:
+    type: str
     description:
       - (inbox only - required) Email address of the message sender
     required: false
   source:
+    type: str
     description:
       - (inbox only - required) Human readable identifier of the application that uses the Flowdock API
     required: false
   subject:
+    type: str
     description:
       - (inbox only - required) Subject line of the message
     required: false
   from_name:
+    type: str
     description:
       - (inbox only) Name of the message sender
     required: false
   reply_to:
+    type: str
     description:
       - (inbox only) Email address for replies
     required: false
   project:
+    type: str
     description:
       - (inbox only) Human readable identifier for more detailed message categorization
     required: false
   link:
+    type: str
     description:
       - (inbox only) Link associated with the message. This will be used to link the message subject in Team Inbox.
     required: false

plugins/modules/notification/grove.py

@@ -17,23 +17,28 @@ description:
        channel.
 options:
   channel_token:
+    type: str
     description:
       - Token of the channel to post to.
     required: true
   service:
+    type: str
     description:
       - Name of the service (displayed as the "user" in the message)
     required: false
     default: ansible
   message:
+    type: str
     description:
       - Message content
     required: true
   url:
+    type: str
     description:
       - Service URL for the web client
     required: false
   icon_url:
+    type: str
     description:
       -  Icon for the service
     required: false

plugins/modules/notification/hipchat.py

@@ -16,28 +16,35 @@ description:
    - Send a message to a Hipchat room, with options to control the formatting.
 options:
   token:
+    type: str
     description:
       - API token.
     required: true
   room:
+    type: str
     description:
       - ID or name of the room.
     required: true
-  from:
+  msg_from:
+    type: str
     description:
       - Name the message will appear to be sent from. Max length is 15
         characters - above this it will be truncated.
     default: Ansible
+    aliases: [from]
   msg:
+    type: str
     description:
       - The message body.
     required: true
   color:
+    type: str
     description:
       - Background color for the message.
     default: yellow
     choices: [ "yellow", "red", "green", "purple", "gray", "random" ]
   msg_format:
+    type: str
     description:
       - Message format.
     default: text
@@ -54,6 +61,7 @@ options:
     type: bool
     default: 'yes'
   api:
+    type: str
     description:
       - API url if using a self-hosted hipchat server. For Hipchat API version
         2 use the default URI with C(/v2) instead of C(/v1).

plugins/modules/notification/irc.py

@@ -16,45 +16,57 @@ description:
    - Send a message to an IRC channel or a nick. This is a very simplistic implementation.
 options:
   server:
+    type: str
     description:
       - IRC server name/address
     default: localhost
   port:
+    type: int
     description:
       - IRC server port number
     default: 6667
   nick:
+    type: str
     description:
       - Nickname to send the message from. May be shortened, depending on server's NICKLEN setting.
     default: ansible
   msg:
+    type: str
     description:
       - The message body.
     required: true
   topic:
+    type: str
     description:
       - Set the channel topic
   color:
+    type: str
     description:
       - Text color for the message. ("none" is a valid option in 1.6 or later, in 1.6 and prior, the default color is black, not "none").
         Added 11 more colors in version 2.0.
     default: "none"
     choices: [ "none", "white", "black", "blue", "green", "red", "brown", "purple", "orange", "yellow", "light_green", "teal", "light_cyan",
                "light_blue", "pink", "gray", "light_gray"]
+    aliases: [colour]
   channel:
+    type: str
     description:
       - Channel name.  One of nick_to or channel needs to be set.  When both are set, the message will be sent to both of them.
-    required: true
   nick_to:
+    type: list
+    elements: str
     description:
       - A list of nicknames to send the message to. One of nick_to or channel needs to be set.  When both are defined, the message will be sent to both of them.
   key:
+    type: str
     description:
       - Channel key
   passwd:
+    type: str
     description:
       - Server password
   timeout:
+    type: int
     description:
       - Timeout to use while waiting for successful registration and join
         messages, this is to prevent an endless loop
@@ -71,9 +83,11 @@ options:
     type: bool
     default: 'yes'
   style:
+    type: str
     description:
       - Text style for the message. Note italic does not work on some clients
-    choices: [ "bold", "underline", "reverse", "italic" ]
+    choices: [ "bold", "underline", "reverse", "italic", "none" ]
+    default: none
 
 # informational: requirements for nodes
 requirements: [ socket ]
@@ -238,7 +252,7 @@ def main():
             server=dict(default='localhost'),
             port=dict(type='int', default=6667),
             nick=dict(default='ansible'),
-            nick_to=dict(required=False, type='list'),
+            nick_to=dict(required=False, type='list', elements='str'),
             msg=dict(required=True),
             color=dict(default="none", aliases=['colour'], choices=["white", "black", "blue",
                                                                     "green", "red", "brown",

plugins/modules/notification/jabber.py

@@ -16,29 +16,36 @@ description:
    - Send a message to jabber
 options:
   user:
+    type: str
     description:
       - User as which to connect
     required: true
   password:
+    type: str
     description:
       - password for user to connect
     required: true
   to:
+    type: str
     description:
       - user ID or name of the room, when using room use a slash to indicate your nick.
     required: true
   msg:
+    type: str
     description:
       - The message body.
     required: true
   host:
+    type: str
     description:
       - host to connect, overrides user info
   port:
+    type: int
     description:
       - port to connect to, overrides default
     default: 5222
   encoding:
+    type: str
     description:
       - message encoding
 

plugins/modules/notification/logentries_msg.py

@@ -18,18 +18,22 @@ requirements:
   - "python >= 2.6"
 options:
   token:
+    type: str
     description:
       - Log token.
     required: true
   msg:
+    type: str
     description:
       - The message body.
     required: true
   api:
+    type: str
     description:
       - API endpoint
     default: data.logentries.com
   port:
+    type: int
     description:
       - API endpoint port
     default: 80

plugins/modules/notification/mail.py

@@ -28,11 +28,12 @@ description:
   one or more people in a team that a specific action has been
   (successfully) taken.
 options:
-  from:
+  sender:
     description:
     - The email-address the mail is sent from. May contain address and phrase.
     type: str
     default: root
+    aliases: [ from ]
   to:
     description:
     - The email-address(es) the mail is being sent to.
@@ -55,11 +56,11 @@ options:
     - The subject of the email being sent.
     required: yes
     type: str
+    aliases: [ msg ]
   body:
     description:
     - The body of the email being sent.
     type: str
-    default: $subject
   username:
     description:
     - If SMTP requires username.

plugins/modules/notification/matrix.py

@@ -16,28 +16,35 @@ description:
     - This module sends html formatted notifications to matrix rooms.
 options:
     msg_plain:
+        type: str
         description:
             - Plain text form of the message to send to matrix, usually markdown
         required: true
     msg_html:
+        type: str
         description:
             - HTML form of the message to send to matrix
         required: true
     room_id:
+        type: str
         description:
             - ID of the room to send the notification to
         required: true
     hs_url:
+        type: str
         description:
             - URL of the homeserver, where the CS-API is reachable
         required: true
     token:
+        type: str
         description:
             - Authentication token for the API call. If provided, user_id and password are not required
     user_id:
+        type: str
         description:
             - The user id of the user
     password:
+        type: str
         description:
             - The password to log in with
 requirements:

plugins/modules/notification/mattermost.py

@@ -22,10 +22,12 @@ description:
 author: "Benjamin Jolivot (@bjolivot)"
 options:
   url:
+    type: str
     description:
       - Mattermost url (i.e. http://mattermost.yourcompany.com).
     required: true
   api_key:
+    type: str
     description:
       - Mattermost webhook api key. Log into your mattermost site, go to
         Menu -> Integration -> Incoming Webhook -> Add Incoming Webhook.
@@ -33,17 +35,21 @@ options:
         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: true
   channel:
+    type: str
     description:
       - Channel to send the message to. If absent, the message goes to the channel selected for the I(api_key).
   username:
+    type: str
     description:
       - This is the sender of the message (Username Override need to be enabled by mattermost admin, see mattermost doc.
     default: Ansible
   icon_url:
+    type: str
     description:
       - Url for the message sender's icon.
     default: https://www.ansible.com/favicon.ico

plugins/modules/notification/mqtt.py

@@ -16,37 +16,45 @@ description:
    - Publish a message on an MQTT topic.
 options:
   server:
+    type: str
     description:
       - MQTT broker address/name
     default: localhost
   port:
+    type: int
     description:
       - MQTT broker port number
     default: 1883
   username:
+    type: str
     description:
       - Username to authenticate against the broker.
   password:
+    type: str
     description:
       - Password for C(username) to authenticate against the broker.
   client_id:
+    type: str
     description:
       - MQTT client identifier
-    default: hostname + pid
+      - If not specified, a value C(hostname + pid) will be used.
   topic:
+    type: str
     description:
       - MQTT topic name
     required: true
   payload:
+    type: str
     description:
       - Payload. The special string C("None") may be used to send a NULL
         (i.e. empty) payload which is useful to simply notify with the I(topic)
         or to clear previously retained messages.
     required: true
   qos:
+    type: str
     description:
       - QoS (Quality of Service)
-    default: 0
+    default: "0"
     choices: [ "0", "1", "2" ]
   retain:
     description:
@@ -56,6 +64,7 @@ options:
     type: bool
     default: 'no'
   ca_cert:
+    type: path
     description:
       - The path to the Certificate Authority certificate files that are to be
         treated as trusted by this client. If this is the only option given
@@ -67,12 +76,14 @@ options:
         is configured.
     aliases: [ ca_certs ]
   client_cert:
+    type: path
     description:
       - The path pointing to the PEM encoded client certificate. If this is not
         None it will be used as client information for TLS based
         authentication. Support for this feature is broker dependent.
     aliases: [ certfile ]
   client_key:
+    type: path
     description:
       - The path pointing to the PEM encoded client private key. If this is not
         None it will be used as client information for TLS based

plugins/modules/notification/nexmo.py

@@ -16,22 +16,27 @@ description:
 author: "Matt Martz (@sivel)"
 options:
   api_key:
+    type: str
     description:
       - Nexmo API Key
     required: true
   api_secret:
+    type: str
     description:
       - Nexmo API Secret
     required: true
   src:
+    type: int
     description:
        - Nexmo Number to send from
     required: true
   dest:
+    type: list
     description:
       - Phone number(s) to send SMS message to
     required: true
   msg:
+    type: str
     description:
       - Message to text to send. Messages longer than 160 characters will be
         split into multiple messages

plugins/modules/notification/office_365_connector_card.py

@@ -19,30 +19,37 @@ notes:
     there will be two Connector Cards created
 options:
   webhook:
+    type: str
     description:
       - The webhook URL is given to you when you create a new Connector.
     required: true
   summary:
+    type: str
     description:
       - A string used for summarizing card content.
       - This will be shown as the message subject.
       - This is required if the text parameter isn't populated.
   color:
+    type: str
     description:
       - Accent color used for branding or indicating status in the card.
   title:
+    type: str
     description:
       - A title for the Connector message. Shown at the top of the message.
   text:
+    type: str
     description:
       - The main text of the card.
       - This will be rendered below the sender information and optional title,
       - and above any sections or actions present.
   actions:
+    type: list
     description:
       - This array of objects will power the action links
       - found at the bottom of the card.
   sections:
+    type: list
     description:
       - Contains a list of sections to display in the card.
       - For more information see https://dev.outlook.com/Connectors/reference.

plugins/modules/notification/pushbullet.py

@@ -18,28 +18,34 @@ description:
    - This module sends push notifications via Pushbullet to channels or devices.
 options:
     api_key:
+        type: str
         description:
             - Push bullet API token
         required: true
     channel:
+        type: str
         description:
             - The channel TAG you wish to broadcast a push notification,
               as seen on the "My Channels" > "Edit your channel" at
               Pushbullet page.
     device:
+        type: str
         description:
             - The device NAME you wish to send a push notification,
               as seen on the Pushbullet main page.
     push_type:
+        type: str
         description:
           - Thing you wish to push.
         default: note
         choices: [ "note", "link" ]
     title:
+        type: str
         description:
           - Title of the notification.
         required: true
     body:
+        type: str
         description:
           - Body of the notification, e.g. Details of the fault you're alerting.
 

plugins/modules/notification/pushover.py

@@ -20,26 +20,34 @@ notes:
      is required to receive messages.
 options:
   msg:
+    type: str
     description:
       - What message you wish to send.
     required: true
   app_token:
+    type: str
     description:
       - Pushover issued token identifying your pushover app.
     required: true
   user_key:
+    type: str
     description:
       - Pushover issued authentication key for your user.
     required: true
   title:
+    type: str
     description:
       - Message title.
     required: false
   pri:
+    type: str
     description:
       - Message priority (see U(https://pushover.net) for details).
     required: false
+    default: '0'
+    choices: [ '-2', '-1', '0', '1', '2' ]
   device:
+    type: str
     description:
       - A device the message should be sent to. Multiple devices can be specified, separated by a comma.
     required: false

plugins/modules/notification/rocketchat.py

@@ -19,17 +19,20 @@ description:
 author: "Ramon de la Fuente (@ramondelafuente)"
 options:
   domain:
+    type: str
     description:
       - The domain for your environment without protocol. (i.e.
         C(example.com) or C(chat.example.com))
     required: true
   token:
+    type: str
     description:
       - Rocket Chat Incoming Webhook integration token.  This provides
         authentication to Rocket Chat's Incoming webhook for posting
         messages.
     required: true
   protocol:
+    type: str
     description:
       - Specify the protocol used to send notification messages before the webhook url. (i.e. http or https)
     default: https
@@ -37,25 +40,31 @@ options:
       - 'http'
       - 'https'
   msg:
+    type: str
     description:
       - Message to be sent.
   channel:
+    type: str
     description:
       - Channel to send the message to. If absent, the message goes to the channel selected for the I(token)
         specified during the creation of webhook.
   username:
+    type: str
     description:
       - This is the sender of the message.
     default: "Ansible"
   icon_url:
+    type: str
     description:
       - URL for the message sender's icon.
     default: "https://www.ansible.com/favicon.ico"
   icon_emoji:
+    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)
   link_names:
+    type: int
     description:
       - Automatically create links for channels and usernames in I(msg).
     default: 1
@@ -69,6 +78,7 @@ options:
     type: bool
     default: 'yes'
   color:
+    type: str
     description:
       - Allow text to use default colors - use the default of 'normal' to not send a custom color bar at the start of the message
     default: 'normal'
@@ -78,6 +88,7 @@ options:
       - 'warning'
       - 'danger'
   attachments:
+    type: list
     description:
       - Define a list of attachments.
 '''

plugins/modules/notification/say.py

@@ -20,10 +20,12 @@ notes:
    - A list of available voices, with language, can be found by running C(say -v ?) on a OSX host and C(espeak --voices) on a Linux host.
 options:
   msg:
+    type: str
     description:
       What to say
     required: true
   voice:
+    type: str
     description:
       What voice to use
     required: false

plugins/modules/notification/sendgrid.py

@@ -28,38 +28,48 @@ requirements:
   - sendgrid python library
 options:
   username:
+    type: str
     description:
       - username for logging into the SendGrid account.
       - Since 2.2 it is only required if api_key is not supplied.
   password:
+    type: str
     description:
       - password that corresponds to the username
       - Since 2.2 it is only required if api_key is not supplied.
   from_address:
+    type: str
     description:
       - the address in the "from" field for the email
     required: true
   to_addresses:
+    type: list
     description:
       - a list with one or more recipient email addresses
     required: true
   subject:
+    type: str
     description:
       - the desired subject for the email
     required: true
   api_key:
+    type: str
     description:
       - sendgrid API key to use instead of username/password
   cc:
+    type: list
     description:
       - a list of email addresses to cc
   bcc:
+    type: list
     description:
       - a list of email addresses to bcc
   attachments:
+    type: list
     description:
       - a list of relative or explicit paths of files you want to attach (7MB limit as per SendGrid docs)
   from_name:
+    type: str
     description:
       - the name you want to appear in the from field, i.e 'John Doe'
   html_body:
@@ -68,8 +78,14 @@ options:
     type: bool
     default: 'no'
   headers:
+    type: dict
     description:
       - a dict to pass on as headers
+  body:
+    type: str
+    description:
+      - the e-mail body content
+    required: yes
 author: "Matt Makai (@makaimc)"
 '''
 

plugins/modules/notification/slack.py

@@ -22,11 +22,13 @@ description:
 author: "Ramon de la Fuente (@ramondelafuente)"
 options:
   domain:
+    type: str
     description:
       - Slack (sub)domain for your environment without protocol. (i.e.
         C(example.slack.com)) In 1.8 and beyond, this is deprecated and may
         be ignored.  See token documentation for information.
   token:
+    type: str
     description:
       - Slack integration token. This authenticates you to the slack service.
         Make sure to use the correct type of token, depending on what method you use.
@@ -50,11 +52,13 @@ options:
         See Slack's documentation (U(https://api.slack.com/docs/token-types)) for more information."
     required: true
   msg:
+    type: str
     description:
       - Message to send. Note that the module does not handle escaping characters.
         Plain-text angle brackets and ampersands should be converted to HTML entities (e.g. & to &) before sending.
         See Slack's documentation (U(https://api.slack.com/docs/message-formatting)) for more.
   channel:
+    type: str
     description:
       - Channel to send the message to. If absent, the message goes to the channel selected for the I(token).
   thread_id:
@@ -68,17 +72,22 @@ options:
     type: str
     version_added: 1.2.0
   username:
+    type: str
     description:
       - This is the sender of the message.
     default: "Ansible"
   icon_url:
+    type: str
     description:
       - Url for the message sender's icon (default C(https://www.ansible.com/favicon.ico))
+    default: https://www.ansible.com/favicon.ico
   icon_emoji:
+    type: str
     description:
       - Emoji for the message sender. See Slack documentation for options.
         (if I(icon_emoji) is set, I(icon_url) will not be used)
   link_names:
+    type: int
     description:
       - Automatically create links for channels and usernames in I(msg).
     default: 1
@@ -86,6 +95,7 @@ options:
       - 1
       - 0
   parse:
+    type: str
     description:
       - Setting for the message parser at Slack
     choices:
@@ -98,12 +108,14 @@ options:
     type: bool
     default: 'yes'
   color:
+    type: str
     description:
       - Allow text to use default colors - use the default of 'normal' to not send a custom color bar at the start of the message.
       - Allowed values for color can be one of 'normal', 'good', 'warning', 'danger', any valid 3 digit or 6 digit hex color value.
       - Specifying value in hex is supported since Ansible 2.8.
     default: 'normal'
   attachments:
+    type: list
     description:
       - Define a list of attachments. This list mirrors the Slack JSON API.
       - For more information, see U(https://api.slack.com/docs/attachments).

plugins/modules/notification/syslogger.py

@@ -13,15 +13,18 @@ description:
     - Uses syslog to add log entries to the host.
 options:
     msg:
+        type: str
         description:
             - This is the message to place in syslog.
         required: True
     priority:
+        type: str
         description:
             - Set the log priority.
         choices: [ "emerg", "alert", "crit", "err", "warning", "notice", "info", "debug" ]
         default: "info"
     facility:
+        type: str
         description:
             - Set the log facility.
         choices: [ "kern", "user", "mail", "daemon", "auth", "lpr", "news",

plugins/modules/notification/telegram.py

@@ -21,10 +21,12 @@ notes:
     - You will require a telegram account and create telegram bot to use this module.
 options:
   msg:
+    type: str
     description:
       - What message you wish to send.
     required: true
   msg_format:
+    type: str
     description:
       - Message format. Formatting options `markdown` and `html` described in
         Telegram API docs (https://core.telegram.org/bots/api#formatting-options).
@@ -32,10 +34,12 @@ options:
     default: plain
     choices: [ "plain", "markdown", "html" ]
   token:
+    type: str
     description:
       - Token identifying your telegram bot.
     required: true
   chat_id:
+    type: str
     description:
       - Telegram group or user chat_id
     required: true

plugins/modules/notification/twilio.py

@@ -22,27 +22,33 @@ notes:
      a purchased or verified phone number to send the text message.
 options:
   account_sid:
+    type: str
     description:
       user's Twilio account token found on the account page
     required: true
   auth_token:
+    type: str
     description: user's Twilio authentication token
     required: true
   msg:
+    type: str
     description:
       the body of the text message
     required: true
   to_numbers:
+    type: list
     description:
       one or more phone numbers to send the text message to,
       format +15551112222
     required: true
     aliases: [ to_number ]
   from_number:
+    type: str
     description:
       the Twilio number to send the text message from, format +15551112222
     required: true
   media_url:
+    type: str
     description:
       a URL with a picture, video or sound clip to send with an MMS
       (multimedia message) instead of a plain SMS

plugins/modules/notification/typetalk.py

@@ -16,18 +16,22 @@ description:
   - Send a message to typetalk using typetalk API
 options:
   client_id:
+    type: str
     description:
       - OAuth2 client ID
     required: true
   client_secret:
+    type: str
     description:
       - OAuth2 client secret
     required: true
   topic:
+    type: int
     description:
       - topic id to post message
     required: true
   msg:
+    type: str
     description:
       - message body
     required: true

tests/sanity/ignore-2.10.txt

@@ -840,68 +840,19 @@ plugins/modules/net_tools/nios/nios_zone.py validate-modules:undocumented-parame
 plugins/modules/net_tools/nsupdate.py validate-modules:parameter-list-no-elements
 plugins/modules/net_tools/nsupdate.py validate-modules:parameter-type-not-in-doc
 plugins/modules/net_tools/omapi_host.py validate-modules:parameter-list-no-elements
-plugins/modules/notification/bearychat.py validate-modules:parameter-list-no-elements
-plugins/modules/notification/bearychat.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/campfire.py validate-modules:doc-missing-type
-plugins/modules/notification/catapult.py validate-modules:doc-missing-type
-plugins/modules/notification/catapult.py validate-modules:parameter-list-no-elements
-plugins/modules/notification/catapult.py validate-modules:parameter-type-not-in-doc
 plugins/modules/notification/cisco_webex.py validate-modules:invalid-argument-name
-plugins/modules/notification/flowdock.py validate-modules:doc-missing-type
 plugins/modules/notification/grove.py validate-modules:invalid-argument-name
 plugins/modules/notification/grove.py validate-modules:nonexistent-parameter-documented
-plugins/modules/notification/grove.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/hipchat.py validate-modules:doc-missing-type
-plugins/modules/notification/hipchat.py validate-modules:undocumented-parameter
-plugins/modules/notification/irc.py validate-modules:doc-choices-do-not-match-spec
-plugins/modules/notification/irc.py validate-modules:doc-default-does-not-match-spec
-plugins/modules/notification/irc.py validate-modules:doc-missing-type
-plugins/modules/notification/irc.py validate-modules:doc-required-mismatch
-plugins/modules/notification/irc.py validate-modules:parameter-list-no-elements
-plugins/modules/notification/irc.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/irc.py validate-modules:undocumented-parameter
-plugins/modules/notification/jabber.py validate-modules:doc-missing-type
-plugins/modules/notification/jabber.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/logentries_msg.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/mail.py validate-modules:doc-default-does-not-match-spec
 plugins/modules/notification/mail.py validate-modules:parameter-list-no-elements
-plugins/modules/notification/mail.py validate-modules:undocumented-parameter
-plugins/modules/notification/matrix.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/mattermost.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/mqtt.py validate-modules:doc-default-does-not-match-spec
-plugins/modules/notification/mqtt.py validate-modules:doc-missing-type
-plugins/modules/notification/mqtt.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/nexmo.py validate-modules:doc-missing-type
 plugins/modules/notification/nexmo.py validate-modules:parameter-list-no-elements
-plugins/modules/notification/nexmo.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/office_365_connector_card.py validate-modules:doc-missing-type
 plugins/modules/notification/office_365_connector_card.py validate-modules:parameter-list-no-elements
-plugins/modules/notification/office_365_connector_card.py validate-modules:parameter-type-not-in-doc
 plugins/modules/notification/pushbullet.py validate-modules:parameter-type-not-in-doc
 plugins/modules/notification/pushbullet.py validate-modules:undocumented-parameter
-plugins/modules/notification/pushover.py validate-modules:doc-choices-do-not-match-spec
-plugins/modules/notification/pushover.py validate-modules:doc-default-does-not-match-spec
-plugins/modules/notification/pushover.py validate-modules:doc-missing-type
-plugins/modules/notification/pushover.py validate-modules:parameter-type-not-in-doc
 plugins/modules/notification/rocketchat.py validate-modules:no-default-for-required-parameter
 plugins/modules/notification/rocketchat.py validate-modules:parameter-list-no-elements
-plugins/modules/notification/rocketchat.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/say.py validate-modules:doc-missing-type
-plugins/modules/notification/sendgrid.py validate-modules:doc-missing-type
-plugins/modules/notification/sendgrid.py validate-modules:doc-required-mismatch
 plugins/modules/notification/sendgrid.py validate-modules:parameter-list-no-elements
-plugins/modules/notification/sendgrid.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/sendgrid.py validate-modules:undocumented-parameter
-plugins/modules/notification/slack.py validate-modules:doc-default-does-not-match-spec
 plugins/modules/notification/slack.py validate-modules:parameter-list-no-elements
-plugins/modules/notification/slack.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/syslogger.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/telegram.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/twilio.py validate-modules:doc-missing-type
 plugins/modules/notification/twilio.py validate-modules:parameter-list-no-elements
-plugins/modules/notification/twilio.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/typetalk.py validate-modules:doc-missing-type
-plugins/modules/notification/typetalk.py validate-modules:parameter-type-not-in-doc
 plugins/modules/packaging/language/bower.py validate-modules:doc-missing-type
 plugins/modules/packaging/language/bower.py validate-modules:parameter-type-not-in-doc
 plugins/modules/packaging/language/bundler.py validate-modules:doc-default-does-not-match-spec

tests/sanity/ignore-2.11.txt

@@ -840,68 +840,19 @@ plugins/modules/net_tools/nios/nios_zone.py validate-modules:undocumented-parame
 plugins/modules/net_tools/nsupdate.py validate-modules:parameter-list-no-elements
 plugins/modules/net_tools/nsupdate.py validate-modules:parameter-type-not-in-doc
 plugins/modules/net_tools/omapi_host.py validate-modules:parameter-list-no-elements
-plugins/modules/notification/bearychat.py validate-modules:parameter-list-no-elements
-plugins/modules/notification/bearychat.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/campfire.py validate-modules:doc-missing-type
-plugins/modules/notification/catapult.py validate-modules:doc-missing-type
-plugins/modules/notification/catapult.py validate-modules:parameter-list-no-elements
-plugins/modules/notification/catapult.py validate-modules:parameter-type-not-in-doc
 plugins/modules/notification/cisco_webex.py validate-modules:invalid-argument-name
-plugins/modules/notification/flowdock.py validate-modules:doc-missing-type
 plugins/modules/notification/grove.py validate-modules:invalid-argument-name
 plugins/modules/notification/grove.py validate-modules:nonexistent-parameter-documented
-plugins/modules/notification/grove.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/hipchat.py validate-modules:doc-missing-type
-plugins/modules/notification/hipchat.py validate-modules:undocumented-parameter
-plugins/modules/notification/irc.py validate-modules:doc-choices-do-not-match-spec
-plugins/modules/notification/irc.py validate-modules:doc-default-does-not-match-spec
-plugins/modules/notification/irc.py validate-modules:doc-missing-type
-plugins/modules/notification/irc.py validate-modules:doc-required-mismatch
-plugins/modules/notification/irc.py validate-modules:parameter-list-no-elements
-plugins/modules/notification/irc.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/irc.py validate-modules:undocumented-parameter
-plugins/modules/notification/jabber.py validate-modules:doc-missing-type
-plugins/modules/notification/jabber.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/logentries_msg.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/mail.py validate-modules:doc-default-does-not-match-spec
 plugins/modules/notification/mail.py validate-modules:parameter-list-no-elements
-plugins/modules/notification/mail.py validate-modules:undocumented-parameter
-plugins/modules/notification/matrix.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/mattermost.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/mqtt.py validate-modules:doc-default-does-not-match-spec
-plugins/modules/notification/mqtt.py validate-modules:doc-missing-type
-plugins/modules/notification/mqtt.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/nexmo.py validate-modules:doc-missing-type
 plugins/modules/notification/nexmo.py validate-modules:parameter-list-no-elements
-plugins/modules/notification/nexmo.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/office_365_connector_card.py validate-modules:doc-missing-type
 plugins/modules/notification/office_365_connector_card.py validate-modules:parameter-list-no-elements
-plugins/modules/notification/office_365_connector_card.py validate-modules:parameter-type-not-in-doc
 plugins/modules/notification/pushbullet.py validate-modules:parameter-type-not-in-doc
 plugins/modules/notification/pushbullet.py validate-modules:undocumented-parameter
-plugins/modules/notification/pushover.py validate-modules:doc-choices-do-not-match-spec
-plugins/modules/notification/pushover.py validate-modules:doc-default-does-not-match-spec
-plugins/modules/notification/pushover.py validate-modules:doc-missing-type
-plugins/modules/notification/pushover.py validate-modules:parameter-type-not-in-doc
 plugins/modules/notification/rocketchat.py validate-modules:no-default-for-required-parameter
 plugins/modules/notification/rocketchat.py validate-modules:parameter-list-no-elements
-plugins/modules/notification/rocketchat.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/say.py validate-modules:doc-missing-type
-plugins/modules/notification/sendgrid.py validate-modules:doc-missing-type
-plugins/modules/notification/sendgrid.py validate-modules:doc-required-mismatch
 plugins/modules/notification/sendgrid.py validate-modules:parameter-list-no-elements
-plugins/modules/notification/sendgrid.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/sendgrid.py validate-modules:undocumented-parameter
-plugins/modules/notification/slack.py validate-modules:doc-default-does-not-match-spec
 plugins/modules/notification/slack.py validate-modules:parameter-list-no-elements
-plugins/modules/notification/slack.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/syslogger.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/telegram.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/twilio.py validate-modules:doc-missing-type
 plugins/modules/notification/twilio.py validate-modules:parameter-list-no-elements
-plugins/modules/notification/twilio.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/typetalk.py validate-modules:doc-missing-type
-plugins/modules/notification/typetalk.py validate-modules:parameter-type-not-in-doc
 plugins/modules/packaging/language/bower.py validate-modules:doc-missing-type
 plugins/modules/packaging/language/bower.py validate-modules:parameter-type-not-in-doc
 plugins/modules/packaging/language/bundler.py validate-modules:doc-default-does-not-match-spec

tests/sanity/ignore-2.9.txt

@@ -653,55 +653,9 @@ plugins/modules/net_tools/nios/nios_zone.py validate-modules:doc-missing-type
 plugins/modules/net_tools/nios/nios_zone.py validate-modules:parameter-type-not-in-doc
 plugins/modules/net_tools/nios/nios_zone.py validate-modules:undocumented-parameter
 plugins/modules/net_tools/nsupdate.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/bearychat.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/campfire.py validate-modules:doc-missing-type
-plugins/modules/notification/catapult.py validate-modules:doc-missing-type
-plugins/modules/notification/catapult.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/flowdock.py validate-modules:doc-missing-type
-plugins/modules/notification/grove.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/hipchat.py validate-modules:doc-default-does-not-match-spec
-plugins/modules/notification/hipchat.py validate-modules:doc-missing-type
-plugins/modules/notification/hipchat.py validate-modules:undocumented-parameter
-plugins/modules/notification/irc.py validate-modules:doc-choices-do-not-match-spec
-plugins/modules/notification/irc.py validate-modules:doc-default-does-not-match-spec
-plugins/modules/notification/irc.py validate-modules:doc-missing-type
-plugins/modules/notification/irc.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/irc.py validate-modules:undocumented-parameter
-plugins/modules/notification/jabber.py validate-modules:doc-missing-type
-plugins/modules/notification/jabber.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/logentries_msg.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/mail.py validate-modules:doc-default-does-not-match-spec
-plugins/modules/notification/mail.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/mail.py validate-modules:undocumented-parameter
-plugins/modules/notification/matrix.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/mattermost.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/mqtt.py validate-modules:doc-default-does-not-match-spec
-plugins/modules/notification/mqtt.py validate-modules:doc-missing-type
-plugins/modules/notification/mqtt.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/nexmo.py validate-modules:doc-missing-type
-plugins/modules/notification/nexmo.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/office_365_connector_card.py validate-modules:doc-missing-type
-plugins/modules/notification/office_365_connector_card.py validate-modules:parameter-type-not-in-doc
 plugins/modules/notification/pushbullet.py validate-modules:parameter-type-not-in-doc
 plugins/modules/notification/pushbullet.py validate-modules:undocumented-parameter
-plugins/modules/notification/pushover.py validate-modules:doc-choices-do-not-match-spec
-plugins/modules/notification/pushover.py validate-modules:doc-default-does-not-match-spec
-plugins/modules/notification/pushover.py validate-modules:doc-missing-type
-plugins/modules/notification/pushover.py validate-modules:parameter-type-not-in-doc
 plugins/modules/notification/rocketchat.py validate-modules:no-default-for-required-parameter
-plugins/modules/notification/rocketchat.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/say.py validate-modules:doc-missing-type
-plugins/modules/notification/sendgrid.py validate-modules:doc-missing-type
-plugins/modules/notification/sendgrid.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/sendgrid.py validate-modules:undocumented-parameter
-plugins/modules/notification/slack.py validate-modules:doc-default-does-not-match-spec
-plugins/modules/notification/slack.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/syslogger.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/telegram.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/twilio.py validate-modules:doc-missing-type
-plugins/modules/notification/twilio.py validate-modules:parameter-type-not-in-doc
-plugins/modules/notification/typetalk.py validate-modules:doc-missing-type
-plugins/modules/notification/typetalk.py validate-modules:parameter-type-not-in-doc
 plugins/modules/packaging/language/bower.py validate-modules:doc-missing-type
 plugins/modules/packaging/language/bower.py validate-modules:parameter-type-not-in-doc
 plugins/modules/packaging/language/bundler.py validate-modules:doc-default-does-not-match-spec