Health Check Response Format for HTTP APIs: Semantic Descriptor

health

• type: semantic
• title: Health Check resource
• doc: APIs.json resource
• def: https://datatracker.ietf.org/doc/html/draft-inadarei-api-health-check-06#section-5
• tag: taxonomy
• descriptor

  id	type	title
  status	semantic	indicates service status (pass, fail, warn)
  version	semantic	Public version of the service.
  releaseId	semantic	Release/version identifier for the service.
  notes	semantic	An array of notes relevant to current state of health
  output	semantic	The raw error output, in case of 'fail' or 'warn' states.
  checks	semantic	List of downstream dependencies
  links	semantic	An object containing link relations and URIs [RFC3986] for external links
  serviceId	semantic	A unique identifier of the service.
  description	semantic	A human-friendly description of the service.
  goHome	safe	Navigate to the home resource

---

home | asd