Is there a new version of Exhale

GET

/api/v1/update

const url = 'http://127.0.0.1:8484/api/v1/update';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://127.0.0.1:8484/api/v1/update \
  --header 'Authorization: Bearer <token>'

The version of Exhale running now and the newest release on GitHub, whether it is newer, what changed (notes and their page), and how this copy was installed: whether apply_update can install it here (the macOS and Windows apps, a binary Exhale may replace) or, if not, the command to run or the file to download (Docker, the Linux packages). Also an update under way: downloading, installing, restarting, or why it failed. refresh asks GitHub again.

Authorizations

bearer

Parameters

Query Parameters

refresh

boolean

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

available

required

boolean

canApply

required

boolean

checkError

string

checkedAt

string

command

string

current

required

string

download

string

latest

string

method

required

string

Allowed values: macos-app windows-app binary package docker

notes

string

notesUrl

string

progress

required

object

done

required

integer format: int64

error

string

phase

required

string

Allowed values: idle downloading installing restarting failed

total

required

integer format: int64

version

string

publishedAt

string

reason

string

Allowed values: "" development manual read-only unsupported

Example

{
  "$schema": "https://example.com/api/schemas/VersionInfo.json",
  "method": "macos-app",
  "progress": {
    "phase": "idle"
  },
  "reason": ""
}

default

Error

application/problem+json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "$schema": "https://example.com/api/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}