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-09 10:26:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

API: Mention compressed parameter for performing backups (#1188)

Browse Source 
Related to: https://github.com/home-assistant/supervisor/pull/3378
This commit is contained in:
Marco Trevisan 2022-02-03 10:25:26 +01:00 committed by GitHub
parent 47ed55f216
commit 4d2e55f16a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -711,6 +711,7 @@ Return a list of [Backups](api/supervisor/models.md#backup)
"type": "partial", "type": "partial",
"size": 44, "size": 44,
"protected": true, "protected": true,
"compressed": true,
"content": { "content": {
"homeassistant": true, "homeassistant": true,
"addons": ["awesome_addon"], "addons": ["awesome_addon"],
@ -730,9 +731,10 @@ Create a full backup.
**Payload:** **Payload:**
| key | type | optional | description | | key | type | optional | description |
| -------- | ------ | -------- | ------------------------------------------ | | ---------- | ------- | -------- | -----------------------------------------|
| name | string | True | The name you want to give the backup | | name | string | True | The name you want to give the backup |
| password | string | True | The password you want to give the backup | | password | string | True | The password you want to give the backup |
| compressed | boolean | True | `false` to create uncompressed backups |
**Example response:** **Example response:**
@ -765,11 +767,12 @@ Create a partial backup.
**Payload:** **Payload:**
| key | type | optional | description | | key | type | optional | description |
| -------- | ------ | -------- | ------------------------------------------- | | ---------- | ------- | -------- | ------------------------------------------- |
| name | string | True | The name you want to give the backup | | name | string | True | The name you want to give the backup |
| password | string | True | The password you want to give the backup | | password | string | True | The password you want to give the backup |
| addons | list | True | A list of strings representing add-on slugs | | addons | list | True | A list of strings representing add-on slugs |
| folders | list | True | A list of strings representing directories | | folders | list | True | A list of strings representing directories |
| compressed | boolean | True | `false` to create uncompressed backups |
**You need to supply at least one key in the payload.** **You need to supply at least one key in the payload.**

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

@ -176,6 +176,7 @@ These models are describing objects that are getting returned from the superviso
| type | string | The type of backup (full, partial) | | type | string | The type of backup (full, partial) |
| protected | boolean | `true` if the backup is password protected | | protected | boolean | `true` if the backup is password protected |
| content | dictionary | A dictionary describing the content of the backup | | content | dictionary | A dictionary describing the content of the backup |
| compressed | boolean | `true` if the backup is saved in a compressed archive |
### Backup -> content ### Backup -> content