Replace the health check with a readiness check. #27
Conversation
This file contains 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
The NDC specification states that the health check should respond with `200 OK` when the connector is ready to start accepting requests (i.e. "readiness"). Whether the underlying data source is up and running is not important here. This adds a default implementation to the method to make it trivial for connector authors to handle this particular request. The method name has been changed to clarify matters and also to force connector authors to understand the change. We will consider adding further endpoints to check "liveness" and "connectedness" in the future.
SamirTalwar
requested review from
paf31,
daniel-chambers,
soupi and
BenoitRanque
plcplc
approved these changes
Aug 8, 2024
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.
The NDC specification states that the health check should respond with
200 OKwhen the connector is ready to start accepting requests (i.e. "readiness").Whether the underlying data source is up and running is not important here.
This adds a default implementation to the method to make it trivial for connector authors to handle this particular request. The method name has been changed to clarify matters and also to force connector authors to understand the change.
We will consider adding further endpoints to check "liveness" and "connectedness" in the future.