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

Related to: home-assistant/supervisor#3378
home-assistant · Feb 3, 2022 · 4d2e55f · 4d2e55f
1 parent 47ed55f
commit 4d2e55f
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 11 deletions.
diff --git a/docs/api/supervisor/endpoints.md b/docs/api/supervisor/endpoints.md
@@ -711,6 +711,7 @@ Return a list of [Backups](api/supervisor/models.md#backup)
       "type": "partial",
       "size": 44,
       "protected": true,
+      "compressed": true,
       "content": {
         "homeassistant": true,
         "addons": ["awesome_addon"],
@@ -729,10 +730,11 @@ Create a full backup.
 
 **Payload:**
 
-| key      | type   | optional | description                                |
-| -------- | ------ | -------- | ------------------------------------------ |
-| name     | string | True     | The name you want to give the backup     |
-| password | string | True     | The password you want to give the backup |
+| key        | type    | optional | description                              |
+| ---------- | ------- | -------- | -----------------------------------------|
+| name       | string  | True     | The name 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:**
 
@@ -764,12 +766,13 @@ Create a partial backup.
 
 **Payload:**
 
-| key      | type   | optional | description                                 |
-| -------- | ------ | -------- | ------------------------------------------- |
-| name     | string | True     | The name 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 |
-| folders  | list   | True     | A list of strings representing directories  |
+| key        | type    | optional | description                                 |
+| ---------- | ------- | -------- | ------------------------------------------- |
+| name       | string  | True     | The name 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 |
+| 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.**
 

diff --git a/docs/api/supervisor/models.md b/docs/api/supervisor/models.md
@@ -175,7 +175,8 @@ These models are describing objects that are getting returned from the superviso
 | name      | string  | The name given to the backup                                        |
 | type      | string  | The type of backup (full, partial)                                  |
 | 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