Interface HealthOutput

Export

HealthOutput

Hierarchy

  • HealthOutput

Properties

description? notes? status version?

Properties

Optional description

description?: string

Human-friendly description of the API.

Memberof

HealthOutput

Optional notes

notes?: string[]

Array of notes relevant to the current state of health.

Memberof

HealthOutput

status

status: HealthOutputStatus

The overall health of the API. pass is healthy, fail is unhealthy, and warn is healthy with some concerns.

Memberof

HealthOutput

Optional version

version?: string

Public version of the API.

Memberof

HealthOutput

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc