Skip to content
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.

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

API: Return "status" and "started" as separate fields #633

Closed
cuu508 opened this issue Apr 8, 2022 · 0 comments
Closed

API: Return "status" and "started" as separate fields #633

cuu508 opened this issue Apr 8, 2022 · 0 comments

Comments

@cuu508
Copy link
Member

cuu508 commented Apr 8, 2022

The web UI displays "up + started" and "down + started" states by showing a an animated progress spinner under the "up" or "down" icon:

image

In comparison, the API currently cannot express the "up + started" and "down + started" states. The API returns a single "status" field with the possible values: new, started, up, grace, down, and paused. Therefore custom dashboards are disadvantaged compared to the standard web UI (see healthchecks/dashboard#8).

Update API to return two fields:

  • status = new|up|grace|down|paused
  • started = true|false

This would be backwards-incompatible change so would probably have to go under /api/v2/.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant