Skip to content

feat(health): define machine-readable health status enums and OpenAPI contract - #298

Merged
memplethee-lab merged 2 commits into
SourceXXL:mainfrom
syntaxsuuvam-spec:feat/issue-288-health-status-contract
Oct 10, 2026
Merged

memplethee-lab merged 2 commits into
SourceXXL:mainfrom
syntaxsuuvam-spec:feat/issue-288-health-status-contract

Conversation

@syntaxsuuvam-spec

Copy link
Copy Markdown
Contributor

Summary

Defines machine-readable ComponentStatus and HealthStatus TypeScript enums in HealthResponseDto, decorates them with @ApiProperty OpenAPI enum metadata, and synchronizes the probe contract documentation in docs/kubernetes-health-probes.md.

Closes #288

Changes

  • src/health/dto/health-response.dto.ts: Exported ComponentStatus (UP, DOWN, DEGRADED, UNKNOWN) and HealthStatus (OK, DEGRADED, ERROR) enums with OpenAPI @ApiProperty({ enum, enumName }) annotations.
  • docs/kubernetes-health-probes.md: Added enum definitions, meanings, and HTTP status mappings for probes.

Verification

  • Fully backwards-compatible with existing controller and service union types.
  • Zero impact on liveness probe execution path.
  • Verified TypeScript compatibility.

@memplethee-lab
memplethee-lab merged commit 8369bbf into SourceXXL:main Oct 10, 2026
2 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.

Add a machine-readable health/status contract so monitoring tools can act without screen-grazing text

2 participants