From 8d27517e230ac63c644b266da754543c4888fb5e Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sun, 24 Sep 2017 11:41:13 +0200 Subject: [PATCH] Update description and move vars to new style --- source/_components/sensor.shodan.markdown | 28 ++++++++++++++++------- 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/source/_components/sensor.shodan.markdown b/source/_components/sensor.shodan.markdown index 7d7727ac109..e4ca7947a21 100644 --- a/source/_components/sensor.shodan.markdown +++ b/source/_components/sensor.shodan.markdown @@ -14,11 +14,14 @@ ha_release: 0.51 --- -The `shodan` sensor platform is displaying the total of result of a [Shodan](https://www.shodan.io/) query. +The `shodan` sensor platform is displaying the total of result of a +[Shodan](https://www.shodan.io/) query. -Use "Show API Key" in the upper right corner when you are logged in or got to your "My Account" page to retrieve your API key. +Use "Show API Key" in the upper right corner when you are logged in or got to +your "My Account" page to retrieve your API key. -To enable this sensor, add the following lines to your `configuration.yaml` file for a GET request: +To enable this sensor, add the following lines to your `configuration.yaml` +file: ```yaml # Example configuration.yaml entry @@ -28,9 +31,18 @@ sensor: query: 'home-assistant' ``` -Configuration variables: - -- **api_key** (*Required*): The API key for Shodan.io. -- **query** (*Required*): The search string. -- **name** (*Optional*): Name of the Shodan sensor. +{% configuration %} + api_key: + description: The API key for Shodan.io. + required: true + type: string + query: + description: The search string. + required: true + type: string + name: + description: Name of the Shodan sensor. + required: false + type: string +{% endconfiguration %}