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-25 02:06:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for new store API (#821)

Browse Source 
* Add documentation for new store API

* add deprecation warning
This commit is contained in:
Joakim Sørensen 2021-03-11 14:35:27 +01:00 committed by GitHub
parent 497a10ed65
commit c0565a7022
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 150 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -241,6 +241,9 @@ Get details about a add-on
<ApiEndpoint path="/addons/<addon>/install" method="post">
Install a add-on
**Deprecated!** Use [`/store/addons/<addon>/install`](#store) instead.
</ApiEndpoint>
<ApiEndpoint path="/addons/<addon>/logo" method="get">
@ -359,6 +362,9 @@ Uninstall a add-on
<ApiEndpoint path="/addons/<addon>/update" method="post">
Update a add-on
**Deprecated!** Use [`/store/addons/<addon>/update`](#store) instead.
</ApiEndpoint>
### Audio
@ -1992,6 +1998,150 @@ Does a partial restore of the snapshot with the given slug.
</ApiEndpoint>
### Store
<ApiEndpoint path="/store" method="get">
Returns add-on store information.
**Example response:**
```json
{ "addons":
[
{
"name": "Awesome add-on",
"slug": "7kshd7_awesome",
"description": "Awesome description",
"repository": "https://example.com/addons",
"version": "1.0.0",
"installed": "1.0.0",
"icon": false,
"logo": true,
"state": "started"
}
],
"repositories": [
{
"slug": "awesom_repository",
"name": "Awesome Repository",
"source": "https://example.com/addons",
"url": "https://example.com/addons",
"maintainer": "Awesome Maintainer"
}
]
}
```
</ApiEndpoint>
<ApiEndpoint path="/store/addons" method="get">
Returns a list of store add-ons
**Example response:**
```json
[
{
"name": "Awesome add-on",
"slug": "7kshd7_awesome",
"description": "Awesome description",
"repository": "https://example.com/addons",
"version": "1.0.0",
"installed": "1.0.0",
"icon": false,
"logo": true,
"state": "started"
}
]
```
</ApiEndpoint>
<ApiEndpoint path="/store/addons/<addon>" method="get">
Returns information about a store add-on
**Example response:**
```json
{
"name": "Awesome add-on",
"slug": "7kshd7_awesome",
"description": "Awesome description",
"repository": "https://example.com/addons",
"version": "1.0.0",
"installed": "1.0.0",
"icon": false,
"logo": true,
"state": "started"
}
```
</ApiEndpoint>
<ApiEndpoint path="/store/addons/<addon>/install" method="post">
Install an add-on from the store.
</ApiEndpoint>
<ApiEndpoint path="/store/addons/<addon>/update" method="post">
Update an add-on from the store.
</ApiEndpoint>
<ApiEndpoint path="/store/reload" method="post">
Reloads the information stored about add-ons.
</ApiEndpoint>
<ApiEndpoint path="/store/repositories" method="get">
Returns a list of store repositories
**Example response:**
```json
[
{
"slug": "awesom_repository",
"name": "Awesome Repository",
"source": "https://example.com/addons",
"url": "https://example.com/addons",
"maintainer": "Awesome Maintainer"
}
]
```
</ApiEndpoint>
<ApiEndpoint path="/store/repositories/<repository>" method="get">
Returns information about a store repository
**Example response:**
```json
{
"slug": "awesom_repository",
"name": "Awesome Repository",
"source": "https://example.com/addons",
"url": "https://example.com/addons",
"maintainer": "Awesome Maintainer"
}
```
</ApiEndpoint>
### Supervisor
<ApiEndpoint path="/supervisor/info" method="get">