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-27 03:06:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add snapshot content (#936)

Browse Source
This commit is contained in:
Joakim Sørensen 2021-05-11 19:17:45 +02:00 committed by GitHub
parent cc11cb87f5
commit 3e17a760e0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1914,8 +1914,13 @@ Return a list of [Snapshot models](api/supervisor/models.md#snapshot)
"slug": "skuwe823", "slug": "skuwe823",
"date": "2020-09-30T20:25:34.273Z", "date": "2020-09-30T20:25:34.273Z",
"name": "Awesome snapshot", "name": "Awesome snapshot",
"type": "full", "type": "partial",
"protected": true "protected": true,
"content": {
"homeassistant": true,
"addons": ["awesome_addon"],
"folders": ["ssl", "media"]
}
} }
] ]
} }

11
docs/api/supervisor/models.md
View File

@ -175,6 +175,17 @@ These models are describing objects that are getting returned from the superviso
| name | string | The name given to the snapshot | | name | string | The name given to the snapshot |
| type | string | The type of snapshot (full, partial) | | type | string | The type of snapshot (full, partial) |
| protected | boolean | `true` if the snapshot is password protected | | 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 ## Snapshot details