jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-27 11:16:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update blueprint schema documentation (#34395)

Browse Source 
* Update blueprint schema documentation

min_version documentation doesn't mention required format, make that explicit in doc and in note about sections

* Update source/_docs/blueprint/schema.markdown

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Update source/_docs/blueprint/schema.markdown

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
This commit is contained in:
jfurtner 2024-08-21 23:41:53 -06:00 committed by GitHub
parent 8479c244fd
commit 452f745aad
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
source/_docs/blueprint/schema.markdown
View File

@ -72,9 +72,10 @@ homeassistant:
keys:
min_version:
description: >
Minimum required version of Home Assistant to use the blueprint. For example,
`2022.4.0`. It is important to set this if the blueprint uses any features
introduced in recent releases to head off issues.
Minimum required version of Home Assistant to use the blueprint in the format of
*major*.*minor*.*patch* (all parts are required). For example, `2022.4.0`. It is
important to set this if the blueprint uses any features introduced in recent
releases to head off issues.
type: string
required: false
input:
@ -154,7 +155,7 @@ allows an optional description, and optionally allows for collapsing those input
A section is differentiated from an input by the presence of an additional `input` key within that section.
{% caution %}
Input sections are a new feature in version 2024.6. Set the `min_version` for the blueprint to at least this version if using input sections. Otherwise, the blueprint will generate errors on older versions.
Input sections are a new feature in version 2024.6.0. Set the `min_version` for the blueprint to at least this version if using input sections. Otherwise, the blueprint will generate errors on older versions.
{% endcaution %}
The full configuration for a section is below: