org.projectfile.health
Shared shape for declaring application health-check surfaces (liveness, readiness, startup probes). Vendor-specific extensions (org.k8s.health, io.docker.health) SHOULD overlay this namespace rather than duplicate it. See spec/v1.md Section 6.6.
- Namespace:
org.projectfile.health - Owner: projectfile.org (community-maintained)
- Status: proposed
Illustrative fragment — not a complete projectfile document. Consumers MUST round-trip unknown namespaces even when no shape is published.
---# SPDX-FileCopyrightText: 2026 Damián Búho <damian.buho@proton.me>## SPDX-License-Identifier: CC-BY-4.0# SPDX-License-Identifier: MIT
# Shape: org.projectfile.health extension namespace# Illustrative fragment — not a complete projectfile document.# See registry.yaml for ownership and status.
org: projectfile: health: endpoints: - path: /health # REQUIRED URL path port: 8080 # OPTIONAL TCP port (1-65535) protocol: http # OPTIONAL http | https | tcp | grpc (default: http) kind: liveness # OPTIONAL liveness | readiness | startup - path: /ready port: 8080 protocol: http kind: readiness[[org.projectfile.health.endpoints]]path = "/health"port = 8080protocol = "http"kind = "liveness"
[[org.projectfile.health.endpoints]]path = "/ready"port = 8080protocol = "http"kind = "readiness"{ "org": { "projectfile": { "health": { "endpoints": [ { "path": "/health", "port": 8080, "protocol": "http", "kind": "liveness" }, { "path": "/ready", "port": 8080, "protocol": "http", "kind": "readiness" } ] } } }}