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

Add documentation for the location key in backups (#1791)

Browse Source 
* Add documentation for the location key in backups

* Apply suggestions from code review

* Tiny tweak. My mistake from before.

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Joakim Sørensen 2023-06-15 16:18:59 +02:00 committed by GitHub
parent bf84552b96
commit 162389d597
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -705,6 +705,7 @@ Return a list of [Backups](api/supervisor/models.md#backup)
"type": "partial",
"size": 44,
"protected": true,
"location": "MountedBackups",
"compressed": true,
"content": {
"homeassistant": true,
@ -742,6 +743,7 @@ Return information about backup manager.
"size": 44,
"protected": true,
"compressed": true,
"location": null,
"content": {
"homeassistant": true,
"addons": ["awesome_addon"],

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

@ -190,18 +190,19 @@ The `content` key of a backup object contains the following keys:
## Backup details
| key | type | description |
| ------------- | ------- | -------------------------------------------------------------------------------------------------------------------------- |
| slug | string | A generated slug for the backup |
| type | string | The type of backup (full, partial) |
| name | string | The name given to the backup |
| date | string | ISO date string representation of the date the backup was created |
| size | string | The size of the backup in MB |
| protected | boolean | `true` if the backup is password protected |
| homeassistant | string | The version of Home Assistant that was in use |
| addons | list | A list of add-ons in the backup, addons are represented as a dictionary with these keys [`slug`,`name`,`version`,`size`] |
| repositories | list | A list of add-on repository URL's as strings |
| folders | list | A list of strings representing directories |
| key | type | description |
| ------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------ |
| slug | string | A generated slug for the backup |
| type | string | The type of backup (full, partial) |
| name | string | The name given to the backup |
| date | string | ISO date string representation of the date the backup was created |
| size | string | The size of the backup in MB |
| protected | boolean | `true` if the backup is password protected |
| location | string or null | The name of the backup mount it's stored on. `null` if it's stored locally. |
| homeassistant | string | The version of Home Assistant that was in use |
| addons | list | A list of add-ons in the backup. Add-ons are represented as a dictionary with these keys [`slug`,`name`,`version`,`size`] |
| repositories | list | A list of add-on repository URL's as strings |
| folders | list | A list of strings representing directories |
## Stats