Health Check Response Format for HTTP APIs: Semantic Descriptor

checks

• type: semantic
• title: List of downstream dependencies
• doc: This object MAY have a number of unique keys, one for each logical downstream dependency or sub-component.
• def: https://datatracker.ietf.org/doc/html/draft-inadarei-api-health-check-06#section-4
• tag: ontology, checks
• descriptor

  id	type	title
  componentName	semantic	Human-readable name for the component.
  measurementName	semantic	Web URL
  componentId	semantic	A unique identifier of an instance of a specific sub-component/dependency.
  componentType	semantic	SHOULD be present if componentName is present (component, datastore, system).
  observedValue	semantic	Any valid JSON value
  observedUnit	semantic	The unit of measurement in which observedValue is reported
  status	semantic	indicates service status (pass, fail, warn)
  affectedEndpoints	semantic	A JSON array containing URI Templates
  time	semantic	The date-time at which the reading of the observedValue was recorded.
  output	semantic	The raw error output, in case of 'fail' or 'warn' states.
  links	semantic	An object containing link relations and URIs [RFC3986] for external links

---

home | asd