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

Add /health endpoint #49

Closed
zacdezgeo opened this issue Sep 10, 2024 · 0 comments · Fixed by #52
Closed

Add /health endpoint #49

zacdezgeo opened this issue Sep 10, 2024 · 0 comments · Fixed by #52
Labels
enhancement New feature or request

Comments

@zacdezgeo
Copy link
Collaborator

zacdezgeo commented Sep 10, 2024

Problem Description

To verify if the API is running, an end-user must either hit the /get_fields or the /summary endpoints. It'd be better practice to have a dedicated endpoint for verifying the status of the API.

Expected behavior

I'd like to verify that the API is up and running by hitting the /health endpoint:

curl -X GET "http://localhost:8000/health"

Expected response:

{
  "status": "ok"
}
@zacdezgeo zacdezgeo added the enhancement New feature or request label Sep 10, 2024
alukach added a commit that referenced this issue Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant