feat: document optional healthCheck in connect.yaml templates - #99
Open
ruiaraujo wants to merge 1 commit into
Open
feat: document optional healthCheck in connect.yaml templates#99ruiaraujo wants to merge 1 commit into
ruiaraujo wants to merge 1 commit into
Conversation
Add an example healthCheck block to the service and event applications in the JavaScript and TypeScript starter templates, and document the healthCheck property and its fields in the README.
ruiaraujo
requested review from
diegodeleonfagundez,
prateek-ct and
ruidias-commercetools
as code owners
August 4, 2026 21:45
|
Author
|
Umbrella PR with full cross-repo context: commercetools/connect-services#2047 |
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.
Description and context
Part of the connector HTTP health-check feature. This updates the author-facing starter templates and documentation so connector developers know how to declare an optional HTTP
healthCheckinconnect.yaml.The full cross-repo context lives in the connect-services PR (linked in a comment below).
Brief description of the solution
healthCheckblock to theserviceandeventapplications in both the JavaScript and TypeScriptconnect.yamltemplates.healthCheckproperty and its fields (path,intervalSeconds,timeoutSeconds,unhealthyThreshold) in the README, including in the sampleconnect.yaml.Type of change
How was it tested?
healthCheckshape matches the schema enforced by the specification package and the deployment pipeline.Depends on another PR/branch?