Skip to content

Supervisor version handling over API #696

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ludeeus merged 2 commits into from
Oct 26, 2020
Merged

Supervisor version handling over API #696

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
021baa8
Supervisor version handling over API
pvizeli Oct 20, 2020
a18c2b0
Update models.md
pvizeli Oct 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 72 additions & 53 deletions docs/api/supervisor/endpoints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,10 @@ Return overview information about add-ons and add-on repositories.
"advanced": false,
"stage": "stable",
"repository": "core",
"version": "1.0.1",
"installed": null,
"version": null,
"version_latest": "1.0.1",
"update_available": false,
"installed": false,
"detached": true,
"available": true,
"build": false,
Expand Down Expand Up @@ -162,6 +164,7 @@ Get details about a add-on
| state | string or null | The state of the add-on (started, stopped) |
| stdin | boolean | `true` if the add-on accepts stdin commands |
| udev | boolean | `true` if udev access is granted is enabled |
| update_available | boolean | `true` if an update is available |
| url | string or null | URL to more information about the add-on |
| usb | list | A list of attached USB devices |
| version | string | The installed version of the add-on |
Expand Down Expand Up @@ -233,6 +236,7 @@ Get details about a add-on
"state": "started",
"stdin": false,
"udev": false,
"update_available": false,
"url": null,
"usb": ["/dev/usb1"],
"version_latest": "1.0.2",
Expand Down Expand Up @@ -433,12 +437,13 @@ Return information about the audio plugin.

**Returned data:**

| key | type | description |
| -------------- | ---------- | ------------------------------- |
| host | string | The IP address of the plugin |
| version | string | The installed observer version |
| version_latest | string | The latest published version |
| audio | dictionary | A [Audio model](api/supervisor/models.md#audio) |
| key | type | description |
| ---------------- | ---------- | -------------------------------- |
| host | string | The IP address of the plugin |
| version | string | The installed observer version |
| version_latest | string | The latest published version |
| update_available | boolean | `true` if an update is available |
| audio | dictionary | A [Audio model](api/supervisor/models.md#audio) |

**Example response:**

Expand All @@ -447,6 +452,7 @@ Return information about the audio plugin.
"host": "172.0.0.19",
"version": "1",
"latest_version": "2",
"update_available": true,
"audio": {
"card": [
{
Expand Down Expand Up @@ -753,17 +759,19 @@ Returns information about the CLI plugin

**Returned data:**

| key | type | description |
| -------------- | ------ | ---------------------------- |
| version | string | The installed CLI version |
| version_latest | string | The latest published version |
| key | type | description |
| ---------------- | ---------- | -------------------------------- |
| version | string | The installed cli version |
| version_latest | string | The latest published version |
| update_available | boolean | `true` if an update is available |

**Example response:**

```json
{
"version": "1",
"version_latest": "2"
"version_latest": "2",
"update_available": true
}
```

Expand Down Expand Up @@ -834,28 +842,30 @@ Returns information about the Home Assistant core

**Returned data:**

| key | type | description |
| -------------- | -------------- | ---------------------------------------------------------- |
| version | string | The installed core version |
| version_latest | string | The latest published version in the active channel |
| arch | string | The architecture of the host (armhf, aarch64, i386, amd64) |
| machine | string | The machine type that is running the host |
| ip_address | string | The internal docker IP address to the supervisor |
| image | string | The container image that is running the core |
| boot | boolean | `true` if it should start on boot |
| port | int | The port Home Assistant is running on |
| ssl | boolean | `true` if Home Assistant is using SSL |
| watchdog | boolean | `true` if watchdog is enabled |
| wait_boot | int | Max time to wait during boot |
| audio_input | string or null | The description of the audio input device |
| audio_output | string or null | The description of the audio output device |
| key | type | description |
| ---------------- | -------------- | ---------------------------------------------------------- |
| version | string | The installed core version |
| version_latest | string | The latest published version in the active channel |
| update_available | boolean | `true` if an update is available |
| arch | string | The architecture of the host (armhf, aarch64, i386, amd64) |
| machine | string | The machine type that is running the host |
| ip_address | string | The internal docker IP address to the supervisor |
| image | string | The container image that is running the core |
| boot | boolean | `true` if it should start on boot |
| port | int | The port Home Assistant is running on |
| ssl | boolean | `true` if Home Assistant is using SSL |
| watchdog | boolean | `true` if watchdog is enabled |
| wait_boot | int | Max time to wait during boot |
| audio_input | string or null | The description of the audio input device |
| audio_output | string or null | The description of the audio output device |

**Example response:**

```json
{
"version": "0.117.0",
"version_latest": "0.117.0",
"update_available": true,
"arch": "arch",
"machine": "amd64",
"ip_address": "172.0.0.15",
Expand Down Expand Up @@ -1054,13 +1064,14 @@ Return information about the DNS plugin.

**Returned data:**

| key | type | description |
| -------------- | ------ | ------------------------------ |
| host | string | The IP address of the plugin |
| version | string | The installed observer version |
| version_latest | string | The latest published version |
| servers | list | A list of DNS servers |
| locals | list | A list of DNS servers |
| key | type | description |
| ---------------- | ------- | -------------------------------- |
| host | string | The IP address of the plugin |
| version | string | The installed observer version |
| version_latest | string | The latest published version |
| update_available | boolean | `true` if an update is available |
| servers | list | A list of DNS servers |
| locals | list | A list of DNS servers |

**Example response:**

Expand All @@ -1069,6 +1080,7 @@ Return information about the DNS plugin.
"host": "127.0.0.18",
"version": "1",
"version_latest": "2",
"update_available": true,
"servers": ["dns://8.8.8.8"],
"locals": ["dns://127.0.0.18"]
}
Expand Down Expand Up @@ -1515,17 +1527,19 @@ Returns information about the multicast plugin

**Returned data:**

| key | type | description |
| -------------- | ------ | ------------------------------ |
| version | string | The installed observer version |
| version_latest | string | The latest published version |
| key | type | description |
| ---------------- | ---------- | --------------------------------- |
| version | string | The installed multicast version |
| version_latest | string | The latest published version |
| update_available | boolean | `true` if an update is available |

**Example response:**

```json
{
"version": "1",
"version_latest": "2"
"version_latest": "2",
"update_available": true
}
```

Expand Down Expand Up @@ -1675,19 +1689,21 @@ Returns information about the observer plugin

**Returned data:**

| key | type | description |
| -------------- | ------ | ----------------------------------------- |
| host | string | The IP address the observer is running on |
| version | string | The installed observer version |
| version_latest | string | The latest published version |
| key | type | description |
| ---------------- | ---------- | -------------------------------- |
| host | string | The IP address of the plugin |
| version | string | The installed observer version |
| version_latest | string | The latest published version |
| update_available | boolean | `true` if an update is available |

**Example response:**

```json
{
"host": "172.0.0.17",
"version": "1",
"version_latest": "2"
"version_latest": "2",
"update_available": true
}
```

Expand Down Expand Up @@ -1744,12 +1760,13 @@ Returns information about the OS.

**Returned data:**

| key | type | description |
| -------------- | ------ | ------------------------------------------------------------ |
| version | string | The current version of the OS |
| version_latest | string | The latest published version of the OS in the active channel |
| board | string | The name of the board |
| boot | string | Which slot that are in use |
| key | type | description |
| ---------------- | ------- | ------------------------------------------------------------ |
| version | string | The current version of the OS |
| version_latest | string | The latest published version of the OS in the active channel |
| update_available | boolean | `true` if an update is available |
| board | string | The name of the board |
| boot | string | Which slot that are in use |

**Example response:**

Expand Down Expand Up @@ -2132,6 +2149,7 @@ Returns information about the supervisor
| ------------------- | ------------ | ------------------------------------------------------------- |
| version | string | The installed supervisor version |
| version_latest | string | The latest published version in the active channel |
| update_available | boolean | `true` if an update is available |
| arch | string | The architecture of the host (armhf, aarch64, i386, amd64) |
| channel | string | The active channel (stable, beta, dev) |
| timezone | string | The current timezone |
Expand All @@ -2141,7 +2159,7 @@ Returns information about the supervisor
| ip_address | string | The internal docker IP address to the supervisor |
| wait_boot | int | Max time to wait during boot |
| debug | bool | Debug is active |
| debug_block | bool | `true` if debug block is enabled |
| debug_block | bool | `true` if debug block is enabled |
| diagnostics | bool or null | Sending diagnostics is enabled |
| addons | list | A list of installed [Addon models](api/supervisor/models.md#addon) |
| addons_repositories | list | A list of add-on repository URL's as strings |
Expand All @@ -2152,6 +2170,7 @@ Returns information about the supervisor
{
"version": "246",
"version_latest": "version_latest",
"update_available": true,
"arch": "amd64",
"channel": "dev",
"timezone": "TIMEZONE",
Expand Down
28 changes: 15 additions & 13 deletions docs/api/supervisor/models.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,21 @@ These models are describing objects that are getting returned from the superviso

## Addon

| key | type | description |
| ----------- | ------- | ----------------------------------------------------- |
| name | string | The name of the add-on |
| slug | string | The slug for the add-on |
| advanced | boolean | `true` if it should only be visible to advanced users |
| description | string | The description of the add-on |
| repository | string | The repository the add-on came from |
| version | string | The latest published version of the add-on |
| installed | string | The installed version of the add-on |
| available | boolean | `false` if you can not install the add-on |
| icon | bool | The add-on has a icon file |
| logo | bool | The add-on has a logo file |
| state | string | The state of the add-on (started, stopped) |
| key | type | description |
| ---------------- | -------------- | ----------------------------------------------------- |
| name | string | The name of the add-on |
| slug | string | The slug for the add-on |
| advanced | boolean | `true` if it should only be visible to advanced users |
| description | string | The description of the add-on |
| repository | string | The repository the add-on came from |
| version | string or null | The installed version of the add-on |
| version_latest | string | The latest published version of the add-on |
| update_available | boolean | `true` if an update is available |
| installed | string | `true` if the the add-on is installed |
| available | boolean | `false` if you can not install the add-on |
| icon | bool | The add-on has a icon file |
| logo | bool | The add-on has a logo file |
| state | string | The state of the add-on (started, stopped) |

## Application

Expand Down