mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-07-14 21:06:28 +00:00
Add documentation for new store API (#821)
* Add documentation for new store API * add deprecation warning
This commit is contained in:
parent
497a10ed65
commit
c0565a7022
@ -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">
|
||||
|
Loading…
x
Reference in New Issue
Block a user