Home-Assistant
/
core
mirror of https://github.com/home-assistant/core.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add missing documentation for some Hassio services (#27215) 

* Add services doc

* Add missing services doc and reformat

* improve readability

* content improvement

* HassIO to Hass.io
pull/27280/head
Oncleben31 2019-10-06 23:02:15 +02:00 committed by Franck Nijhof
parent 02c983d332
commit 3b9f0062a2
1 changed files with 68 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

89
homeassistant/components/hassio/services.yaml
View File

@ -1,37 +1,84 @@
addon_install: addon_install:
description: Install a HassIO docker addon. description: Install a Hass.io docker add-on.
fields: fields:
addon: {description: Name of addon., example: smb_config} addon:
version: {description: Optional or it will be use the latest version., example: '0.2'} description: The add-on slug.
example: core_ssh
version:
description: Optional or it will be use the latest version.
example: "0.2"
addon_start: addon_start:
description: Start a HassIO docker addon. description: Start a Hass.io docker add-on.
fields: fields:
addon: {description: Name of addon., example: smb_config} addon:
description: The add-on slug.
example: core_ssh
addon_restart:
description: Restart a Hass.io docker add-on.
fields:
addon:
description: The add-on slug.
example: core_ssh
addon_stdin:
description: Write data to a Hass.io docker add-on stdin .
fields:
addon:
description: The add-on slug.
example: core_ssh
addon_stop: addon_stop:
description: Stop a HassIO docker addon. description: Stop a Hass.io docker add-on.
fields: fields:
addon: {description: Name of addon., example: smb_config} addon:
description: The add-on slug.
example: core_ssh
addon_uninstall: addon_uninstall:
description: Uninstall a HassIO docker addon. description: Uninstall a Hass.io docker add-on.
fields: fields:
addon: {description: Name of addon., example: smb_config} addon:
description: The add-on slug.
example: core_ssh
addon_update: addon_update:
description: Update a HassIO docker addon. description: Update a Hass.io docker add-on.
fields: fields:
addon: {description: Name of addon., example: smb_config} addon:
version: {description: Optional or it will be use the latest version., example: '0.2'} description: The add-on slug.
example: core_ssh
version:
description: Optional or it will be use the latest version.
example: "0.2"
homeassistant_update: homeassistant_update:
description: Update HomeAssistant docker image. description: Update the Home Assistant docker image.
fields: fields:
version: {description: Optional or it will be use the latest version., example: 0.40.1} version:
host_reboot: {description: Reboot host computer.} description: Optional or it will be use the latest version.
host_shutdown: {description: Poweroff host computer.} example: 0.40.1
host_reboot:
description: Reboot the host system.
host_shutdown:
description: Poweroff the host system.
host_update: host_update:
description: Update host computer. description: Update the host system.
fields: fields:
version: {description: Optional or it will be use the latest version., example: '0.3'} version:
supervisor_reload: {description: Reload HassIO supervisor addons/updates/configs.} description: Optional or it will be use the latest version.
example: "0.3"
supervisor_reload:
description: Reload the Hass.io supervisor.
supervisor_update: supervisor_update:
description: Update HassIO supervisor. description: Update the Hass.io supervisor.
fields: fields:
version: {description: Optional or it will be use the latest version., example: '0.3'} version:
description: Optional or it will be use the latest version.
example: "0.3"