Repository navigation
update /healthz endpoint to return a JSON payload - #402
Conversation
🦋 Changeset detectedLatest commit: 0c81459 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
080336e to
2cf8887
Compare
There was a problem hiding this comment.
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).
❌ 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.
2cf8887 to
f32e05d
Compare
chiragjn
left a comment
There was a problem hiding this comment.
Adding comments. Just cleanup the test and we are good to go here
f32e05d to
5a4aafa
Compare
|
@chiragjn, alright, please review it now! :) |

Summary
Updated the
/healthzendpoint to return a JSON status payload containing the current package version.Closes #378
Changes
/healthzto return{ "status": "ok", "version": PACKAGE_VERSION }.How was this tested?
curl.Checklist
pnpm build,pnpm test,pnpm typecheck,pnpm lint:ci, andpnpm format:checkpass locallypackages/trueforge-sdk,.github/fern/openapi/openapi.json,docs/openapi.json) — fork PRs omit SDK regen; maintainers regenerate after merge.env.exampleupdated if configuration or behavior changedNote
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 /healthznow returns JSON{ status: "ok", version }usingPACKAGE_VERSIONinstead of the plain-textOK!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.