diff --git a/docs/api/supervisor/endpoints.md b/docs/api/supervisor/endpoints.md index ae8216e6..e6caadad 100644 --- a/docs/api/supervisor/endpoints.md +++ b/docs/api/supervisor/endpoints.md @@ -1772,35 +1772,56 @@ Update Home Assistant OS | 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 | +| issues | list | A list of [Issue models](api/supervisor/models.md#issues) | +| suggestions | list | A list of [Suggestion models](api/supervisor/models.md#suggestion) actions | **Example response:** ```json { "unsupported": ["os"], - "issues": ["free_space"], - "suggestions": ["clear_snapshots"] + "issues": [ + { + "uuid": "A89924620F9A11EBBDC3C403FC2CA371", + "type": "free_space", + "context": "system", + "reference": null + } + ], + "suggestions": [ + { + "uuid": "B9923620C9A11EBBDC3C403FC2CA371", + "type": "clear_snapshots", + "context": "system", + "reference": null + } + ] } ```
-/resolution/[suggestion] +/resolution/suggestion/[uuid] Apply a suggested action
-/resolution/[suggestion]/dismiss +/resolution/suggestion/[uuid] Dismiss a suggested action
+
+/resolution/issue/[uuid] + +Dismiss a issue + +
+ ### Service
diff --git a/docs/api/supervisor/models.md b/docs/api/supervisor/models.md index 27f73102..ed313b4e 100644 --- a/docs/api/supervisor/models.md +++ b/docs/api/supervisor/models.md @@ -165,3 +165,21 @@ These models are describing objects that are getting returned from the superviso | network_rx | int | Network receiver usage | | blk_read | int | File system read usage | | blk_write | int | File system write usage | + +## Issue + +| key | type | description | +| ----------| ----------- | --------------------------------------------------- | +| uuid | str | A generated uuid as issue ID | +| type | str | Type of the issue | +| context | str | In which context the issue occorse | +| reference | str or null | Depend on the Context, a reference to a other Model | + +## Suggestion + +| key | type | description | +| ----------| ----------- | --------------------------------------------------- | +| uuid | str | A generated uuid as suggestion ID | +| type | str | Type of the suggestion | +| context | str | In which context the suggestion occorse | +| reference | str or null | Depend on the Context, a reference to a other Model |