HealthStatus

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HealthStatus",
  "title": "HealthStatus",
  "type": "object",
  "description": "The health status of the Xceptor API services",
  "properties": {
    "status": {
      "type": "string",
      "description": "The overall health status of the API",
      "enum": [
        "healthy",
        "degraded",
        "unhealthy"
      ]
    },
    "version": {
      "type": "string",
      "description": "The API version"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time",
      "description": "The time the health check was performed"
    },
    "services": {
      "type": "object",
      "description": "Status of individual dependent services",
      "additionalProperties": {
        "type": "string",
        "enum": [
          "healthy",
          "unhealthy"
        ]
      }
    }
  }
}