Skip to content

update /healthz endpoint to return a JSON payload - #402

Merged
chiragjn merged 2 commits into
truefoundry:mainfrom
Aman-goel-04:fix/update-healthz-response
Aug 22, 2026
Merged

chiragjn merged 2 commits into
truefoundry:mainfrom
Aman-goel-04:fix/update-healthz-response

Conversation

@Aman-goel-04

@Aman-goel-04 Aman-goel-04 commented Aug 22, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Updated the /healthz endpoint to return a JSON status payload containing the current package version.

Closes #378

Changes

  • Updated /healthz to return { "status": "ok", "version": PACKAGE_VERSION }.
  • Added a regression test covering the health-check response.

How was this tested?

  • Verified the endpoint locally with curl.
Screenshot 2026-08-22 at 1 08 12 PM
  • Added and ran the corresponding unit test.

Checklist

  • I have read the contributing guidelines
  • pnpm build, pnpm test, pnpm typecheck, pnpm lint:ci, and pnpm format:check pass locally
  • Tests added/updated where it makes sense
  • No hand-edits to generated code (packages/trueforge-sdk, .github/fern/openapi/openapi.json, docs/openapi.json) — fork PRs omit SDK regen; maintainers regenerate after merge
  • Docs / .env.example updated if configuration or behavior changed

Note

Low Risk
Small public health-check response-shape change. Probes that only check HTTP status remain valid; anything expecting the old OK! text would break.

Overview
GET /healthz now returns JSON { status: "ok", version } using PACKAGE_VERSION instead of the plain-text OK! body.

Compose still probes HTTP success only (r.ok); the comment was updated to match. Patch changeset included.

Reviewed by Cursor Bugbot for commit 0c81459. Bugbot is set up for automated code reviews on this repo. Configure here.

@changeset-bot

changeset-bot Bot commented Aug 22, 2026 •

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 0c81459

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@truefoundry/trueforge Patch

Not sure what this means? Click here to learn what changesets are.

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

Comment thread packages/trueforge/src/app.ts Resolved
@Aman-goel-04
Aman-goel-04 force-pushed the fix/update-healthz-response branch from 080336e to 2cf8887 Compare August 22, 2026 08:27

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

There are 2 total unresolved issues (including 1 from previous review).

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 2cf8887. Configure here.

Comment thread packages/trueforge/src/app.ts Resolved
@Aman-goel-04
Aman-goel-04 force-pushed the fix/update-healthz-response branch from 2cf8887 to f32e05d Compare August 22, 2026 08:39

@chiragjn chiragjn left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding comments. Just cleanup the test and we are good to go here

@Aman-goel-04
Aman-goel-04 force-pushed the fix/update-healthz-response branch from f32e05d to 5a4aafa Compare August 22, 2026 08:54
@Aman-goel-04

Copy link
Copy Markdown
Contributor Author

@chiragjn, alright, please review it now! :)

@chiragjn
chiragjn enabled auto-merge (squash) August 22, 2026 10:42
@chiragjn
chiragjn disabled auto-merge August 22, 2026 10:49
@chiragjn
chiragjn merged commit 5ccac3d into truefoundry:main Aug 22, 2026
7 checks passed
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.

Update /healthz to return JSON status payload

2 participants