jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-13 04:16:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add suggestion endpoints for resolution (#683)

Browse Source
This commit is contained in:
Joakim Sørensen 2020-10-14 17:16:56 +02:00 committed by GitHub
parent 0e712081ed
commit 78d8455733
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 40 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
docs/api/supervisor/endpoints.md
View File

@ -1498,25 +1498,6 @@ Returns a dict with selected keys from other `/*/info` endpoints.
</details> </details>
<details>
<summary className="endpoint get protected">/resolution</summary>
**Returned data:**
| key | type | description |
| -------- | ---------- | ------------------------------------------------ |
| unsupported | list | A list of reasons why a installation is marked as unsupported (container, dbus, docker_configuration, docker_version, lxc, network_manager, os, privileged, systemd) |
**Example response:**
```json
{
"unsupported": ["os"]
}
```
</details>
### Multicast ### Multicast
<details> <details>
@ -1780,6 +1761,45 @@ Update Home Assistant OS
</details> </details>
### Resolution
<details>
<summary className="endpoint get protected">/resolution</summary>
**Returned data:**
| key | type | description |
| -------- | ---------- | ------------------------------------------------ |
| unsupported | list | A list of reasons why a installation is marked as unsupported (container, dbus, docker_configuration, docker_version, lxc, network_manager, os, privileged, systemd) |
| issues | list | A list of issues |
| suggestions | list | A list of suggested actions |
**Example response:**
```json
{
"unsupported": ["os"],
"issues": ["free_space"],
"suggestions": ["clear_snapshots"]
}
```
</details>
<details>
<summary className="endpoint post protected">/resolution/[suggestion]</summary>
Apply a suggested action
</details>
<details>
<summary className="endpoint post protected">/resolution/[suggestion]/dismiss</summary>
Dismiss a suggested action
</details>
### Service ### Service
<details> <details>
@ -2220,4 +2240,5 @@ Some of the endpoints uses placeholders indicated with `[]` in the endpoint URL.
| registry | A registry hostname defined in the container registry configuration, to get the hostname you can call `/docker/registries` | | registry | A registry hostname defined in the container registry configuration, to get the hostname you can call `/docker/registries` |
| service | The service name for a service on the host. | | service | The service name for a service on the host. |
| snapshot | A valid snapshot slug, example `skuwe823`, to get the slug you can call `/snapshots` | | snapshot | A valid snapshot slug, example `skuwe823`, to get the slug you can call `/snapshots` |
| suggestion | A valid suggestion, example `clear_full_snapshot`, to get the suggestion you can call `/resolution` |
| uuid | The UUID of a discovery service, to get the UUID you can call `/discovery` | | uuid | The UUID of a discovery service, to get the UUID you can call `/discovery` |