Implement health and version API endpoints#233
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 0bc22b01ef
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
du-dhartley
left a comment
There was a problem hiding this comment.
@pranavisrikanth I understand the point of the health check, but why is /version here?
That will return the version that's specified in this file, which hasn't been updated nor will return a useful value if there's more than one available API version.
In addition to this, the code in the /health endpoint is actually more of a liveness check than it is a health check. Health checks would typically rely on dependencies to return successful checks before returning healthy here; this endpoint has effectively the same functionality as the root / endpoint above it.
I'd suggest removing /version, and either changing /health to /liveness or consider removing it also. There's no real functionality gain here.
Summary
Implemented lightweight backend API endpoints for service health and version visibility.
Endpoints added:
GET /healthGET /versionType of Change
Affected Components
/backend-api/frontend/engine(collectors / policies)/security/infrastructure/.github/workflows/docsMotivation
Health and version endpoints support backend operational visibility and can be used for deployment validation, monitoring, and service status checks.
Testing Done
Verified the new route definitions in
backend-api/app/main.py.Security Considerations
No sensitive data is exposed. Endpoints only return basic operational metadata.
Breaking Changes
Rollback Plan
Checklist
Screenshots
No.