Skip to content

[M1] Add V2 health and database readiness endpoints #10

Description

@rodrigolinhas

Goal

Provide the first infrastructure-level API endpoint proving NestJS and PostgreSQL are wired correctly.

Suggested Distinction

  • health (/api/v2/health or /health): application process is alive.
  • readiness (/api/v2/readiness or /readiness): required dependencies, including PostgreSQL, are usable.

Do not overengineer observability.

Acceptance Criteria

  • Application health endpoint exists.
  • Database readiness can be checked.
  • Database failure does not produce misleading "healthy" status.
  • Appropriate HTTP status codes are used (200 OK vs 503 Service Unavailable).
  • Endpoints are documented.
  • Automated API tests exist.

Dependencies

Suggested PR

PR 3 — Health/readiness + OpenAPI + testing foundation (with Issues F and G)

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions