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

Define and implement a GHC REST API for remote monitoring and reporting #325

Open
justb4 opened this issue Jun 9, 2020 · 1 comment
Open

Comments

@justb4
Copy link
Member

justb4 commented Jun 9, 2020

Is your feature request related to a problem? Please describe.
Several cases where access to GHC data is required in custom monitoring and reporting tools.
Though a full CRUD API is desired in the long term, as described in issue #20 this issue here is just for a READ API to support remote monitoring and reporting.

Describe the solution you'd like
GHC should offer a REST API to provide data for remote integrations.

Describe alternatives you've considered
Remote apps could "scrape" data from the HTML of a GHC instance, but that is not a robust/clean solution.

Additional context
At integrations in remote monitoring tools and custom reporting.

NB note that the current GHC version already has some API support with JSON responses. The list is:

https://demo.geohealthcheck.org/api/v1.0/summary/ of
https://demo.geohealthcheck.org/api/v1.0/summary.json
https://demo.geohealthcheck.org/api/v1.0/summary.html

https://demo.geohealthcheck.org/api/v1.0/runs/<resource_id>[.<content_type>
https://demo.geohealthcheck.org/api/v1.0/runs/27
https://demo.geohealthcheck.org/api/v1.0/runs/27.json
https://demo.geohealthcheck.org/api/v1.0/runs/27.html

The work is two-phased:

  1. define a REST API specification for read-only operations to support remote monitoring and reporting
  2. implement that specification

This issue only covers the first phase. The second will be covered in a separate issue.

@justb4
Copy link
Member Author

justb4 commented Jun 9, 2020

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

No branches or pull requests

1 participant