Skip to content

feat: document optional healthCheck in connect.yaml templates - #99

Open
ruiaraujo wants to merge 1 commit into
mainfrom
feat/connector-health-check
Open

feat: document optional healthCheck in connect.yaml templates#99
ruiaraujo wants to merge 1 commit into
mainfrom
feat/connector-health-check

Conversation

@ruiaraujo

Copy link
Copy Markdown

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 healthCheck in connect.yaml.

The full cross-repo context lives in the connect-services PR (linked in a comment below).

Brief description of the solution

  • Added an example healthCheck block to the service and event applications in both the JavaScript and TypeScript connect.yaml templates.
  • Documented the healthCheck property and its fields (path, intervalSeconds, timeoutSeconds, unhealthyThreshold) in the README, including in the sample connect.yaml.

Type of change

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

How was it tested?

  • Manual review of the rendered templates and README; the healthCheck shape matches the schema enforced by the specification package and the deployment pipeline.

Depends on another PR/branch?

  • Yes — depends on the schema/pipeline changes in the connect-services PR (linked in a comment below).

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.
@changeset-bot

changeset-bot Bot commented Aug 4, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 031efdd

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@ruiaraujo

Copy link
Copy Markdown
Author

Umbrella PR with full cross-repo context: commercetools/connect-services#2047

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant