Add a status field to /api response #6
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a
Statusfield to the JSON response of the rootGET /apiendpoint. The status is either"ok"or"warn"(an "error" would be if the endpoint wasn't reachable at all). Right now the status iswarnif the last updated timestamp on the OSMX file is > 15 minutes ago, andokotherwise. We can add additional checks later if we want.The intent of this field is that we can set up the OSM US status page (which uses a third-party service, updown.io) to
GET /apiand grep for"Status": "ok"in the response. If it doesn't find that string it can show the service as degraded in the dashboard, send us emails, etc.