From 3e17a760e01f78ccd22c0263cd4da3665b3babd8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20S=C3=B8rensen?= Date: Tue, 11 May 2021 19:17:45 +0200 Subject: [PATCH] Add snapshot content (#936) --- docs/api/supervisor/endpoints.md | 9 +++++++-- docs/api/supervisor/models.md | 11 +++++++++++ 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/docs/api/supervisor/endpoints.md b/docs/api/supervisor/endpoints.md index a834922c..de5dd287 100644 --- a/docs/api/supervisor/endpoints.md +++ b/docs/api/supervisor/endpoints.md @@ -1914,8 +1914,13 @@ Return a list of [Snapshot models](api/supervisor/models.md#snapshot) "slug": "skuwe823", "date": "2020-09-30T20:25:34.273Z", "name": "Awesome snapshot", - "type": "full", - "protected": true + "type": "partial", + "protected": true, + "content": { + "homeassistant": true, + "addons": ["awesome_addon"], + "folders": ["ssl", "media"] + } } ] } diff --git a/docs/api/supervisor/models.md b/docs/api/supervisor/models.md index d35d6dbf..b75ca8c5 100644 --- a/docs/api/supervisor/models.md +++ b/docs/api/supervisor/models.md @@ -175,6 +175,17 @@ These models are describing objects that are getting returned from the superviso | name | string | The name given to the snapshot | | type | string | The type of snapshot (full, partial) | | protected | boolean | `true` if the snapshot is password protected | +| content | dictionary | A dictionary describing the content of the snapshot | + +### Snapshot -> content + +The `content` key of a snapshot object contains the following keys: + +| key | type | description | +| --------- | ------- | --------------------------------------------------------------------- | +| homeassistant | boolean | `true` if the snapshot contains homeassistant +| addons | list | A list of add-on slugs included in the snapshot +| folders | list | A list of folder names included in the snapshot ## Snapshot details