[C4GT Community]: Implement /health and /version Endpoints Across All API Repositories

[Sneha6003]

Ticket Contents

Description

We need to implement standard /health and /version endpoints across all API repositories to improve observability, maintainability, and deployment traceability.

/health: Should return a minimal response indicating the service is live and healthy. Useful for uptime monitoring, and load balancers.

/version: Should return metadata including the latest Git commit hash and build timestamp.

Goals

Goals

• Implement /health in all API services with a 200 response and status message.
• Implement /version to return commit hash and build timestamp.
• Automate generation of version metadata during the build.
• Ensure all responses follow a consistent JSON schema across services.

Expected Outcome

• Every API repository has a functional /health and /version endpoint.
• Endpoints are minimal, fast, and production-safe.
• No disruption to existing routes or CI/CD workflows.

Acceptance Criteria

• /health responds with { "status": "UP" } on all services.
• /version returns consistent metadata in JSON format.
• GitHub Actions or other CI tools validate the presence of these endpoints.

Implementation Details

• Use existing web framework to expose both endpoints.
• Ensure these endpoints are lightweight, do not require authentication, and are safe to expose in production.

Mockups/Wireframes

No response

Product Name

AMRIT

Organisation Name

Piramal Swasthya Management and Research Institute

Domain

No response

Tech Skills Needed

Spring Boot

Organizational Mentor

@drtechie

Angel Mentor

No response

Complexity

Medium

Category

Configuration, CI/CD, Accessibility

[rohan-019]

Hey @Sneha6003, may I take this up?

[Sneha6003]

@rohan-019 assigned it to you, please make sure to read CONTRIBUTOR_GUIDELINES.md before you begin!

[ridh21]

Hello @Sneha6003 Can I work on this issue?

[drtechie]

@rohan-019 is there an update?
When can you raise a PR?

[sunilkumar2170]

Hi! I would like to work on this issue. Please assign it to me.

[Sneha6003]

Assigning to @ridh21 since there has been no update from Rohan in over a week.

[ridh21]

@Sneha6003 Noted. Will be start working on this by today itself.

[ridh21]

Hi @Sneha6003 @drtechie,
I have a quick clarification: since the task involves implementing the API endpoints across all the API repositories, should I fork each of them individually to make the changes?

Also, I noticed that the ticket mentions Node.js as the tech stack, but upon reviewing the repositories, I found that they are all built using Spring Boot. Should I proceed with the implementation in Spring Boot?

[Sneha6003]

Hi @ridh21 ,

Thanks for checking!

Yes, please fork each repository separately and submit individual PRs for the /health and /version endpoints.

You're correct, the tech stack is Spring Boot, not Node.js, so please go ahead with the Spring Boot implementation. The Node.js mention in the ticket was an error, thanks for catching that!

[Sneha6003]

hi @ridh21 any updates?

[codewithbear]

Would be happy to help with automating the fix for this