From 2edafd99530cbeb9d8f42f3097f72f328274d917 Mon Sep 17 00:00:00 2001 From: Stuart McCroden Date: Thu, 1 Nov 2018 03:50:34 -0500 Subject: [PATCH] Update Slack Notify configuration variables style (#7283) * Update Slack Notify configuration variables Use the new style for configuration variables description #6385 for notify.slack.markdown * Added type value for config vars in notify.slack * Minor changes --- source/_components/notify.slack.markdown | 29 ++++++++++++++++++------ 1 file changed, 22 insertions(+), 7 deletions(-) diff --git a/source/_components/notify.slack.markdown b/source/_components/notify.slack.markdown index e3b5911f859..3b978bda146 100644 --- a/source/_components/notify.slack.markdown +++ b/source/_components/notify.slack.markdown @@ -42,13 +42,28 @@ notify: default_channel: '#general' ``` -Configuration variables: - -- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`. -- **api_key** (*Required*): The Slack API token to use for sending Slack messages. -- **default_channel** (*Required*): The default channel to post to if no channel is explicitly specified when sending the notification message. A channel can be specified adding a target attribute to the json at the same level as "message" -- **username** (*Optional*): Setting username will allow Home Assistant to post to Slack using the username specified. By default not setting this will post to Slack using the user account or botname that you generated the api_key as. -- **icon** (*Optional*): Use one of the Slack emojis as an Icon for the supplied username. Slack uses the standard emoji sets used [here](http://www.webpagefx.com/tools/emoji-cheat-sheet/). +{% configuration %} +name: + description: Setting this parameter allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`. + required: false + default: "notify" +api_key: + description: The Slack API token to use for sending Slack messages. + required: true + type: string +default_channel: + description: The default channel to post to if no channel is explicitly specified when sending the notification message. A channel can be specified adding a target attribute to the JSON at the same level as "message". + required: true + type: string +username: + description: Home Assistant will post to Slack using the username specified. + required: false + type: string + default: The user account or botname that you generated the API key as. +icon: + description: Use one of the Slack emojis as an Icon for the supplied username. Slack uses the standard emoji sets used [here](http://www.webpagefx.com/tools/emoji-cheat-sheet/). + required: false +{% endconfiguration %} ### {% linkable_title Slack service data %}