From fb4d4c87161b5fe1a134e736f405e55411a73b05 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Thu, 8 Nov 2018 09:30:31 +0100 Subject: [PATCH] Update rss_feed_template component configuration (#7415) --- source/_components/rss_feed_template.markdown | 36 ++++++++++++++----- 1 file changed, 28 insertions(+), 8 deletions(-) diff --git a/source/_components/rss_feed_template.markdown b/source/_components/rss_feed_template.markdown index 36fcddfc51f..8272e106476 100644 --- a/source/_components/rss_feed_template.markdown +++ b/source/_components/rss_feed_template.markdown @@ -30,11 +30,31 @@ rss_feed_template: description: "{% raw %}{% if is_state('sensor.temp_outside','unknown') %}---{% else %}{{states.sensor.temp_outside.state}} °C{% endif %}{% endraw %}" ``` -Configuration variables: - -- **requires_api_password:** (*Optional*): If true and an API password is set, the password must be passed via '?api_password=...' parameter (Default: True) -- **feed_id** (*Required*): The key is used as the ID of the feed. The feed can be accessed at /api/rss_template/feed_id (example: 'garden') -- **title** (*Optional*): The title of the feed, which is parsed as [template](/topics/templating/). -- **items** (*Required*): A list of feed items. -- **items/title** (*Optional*): The title of the item, which is parsed as [template](/topics/templating/). -- **items/description** (*Optional*): The description of the item, which is parsed as [template](/topics/templating/). +{% configuration %} +requires_api_password: + description: If true and an API password is set, the password must be passed via '?api_password=...' parameter. + required: false + default: true + type: boolean +feed_id: + description: "The key is used as the ID of the feed. The feed can be accessed at /api/rss_template/feed_id (example: 'garden')." + required: true + type: string +title: + description: The title of the feed, which is parsed as [template](/topics/templating/). + required: false + type: template +items: + description: A list of feed items. + required: true + type: list + keys: + title: + description: The title of the item, which is parsed as [template](/topics/templating/). + required: false + type: template + description: + description: The description of the item, which is parsed as [template](/topics/templating/). + required: false + type: template +{% endconfiguration %}