health-endpoint

Requires an API to expose both GET /health and GET /health/info endpoint shapes.

Attribute	Value
Category	Operations
Maturity	Gold
OpenAPI	Swagger 2.0; OpenAPI 3.0, 3.1, 3.2
Starter	Off
Lenient–Strict	Warning
Complete	Error

Intent

Predictable health endpoints make service monitoring and operational integration consistent across APIs.

Flags

The document once when either required GET endpoint is missing. Paths match after removing trailing slashes and may have a prefix, such as /service/health.

Does not flag

An API containing GET paths ending in both /health and /health/info. A path with another HTTP method does not satisfy the rule.

See it fail

paths:
  /health:
    get:
      responses:
        '200':
          description: OK

/health/info is missing.

Fix it

paths:
  /health:
    get:
      responses:
        '200':
          description: OK
  /health/info:
    get:
      responses:
        '200':
          description: Health details

Configure

profiles:
  default:
    rules:
      extends: [recommended]
      override:
        health-endpoint: error

Nearby: health-endpoint-media-type, health-schema-status, health-schema-checks.