Struct StatusPayload 

pub struct StatusPayload {
    pub health: Vec<HealthCheck>,
    pub healthy: Option<bool>,
}

A status push: a server’s periodic heartbeat carrying its self-reported health.

Besides the reserved healthy and health keys described here, any additional top-level fields are accepted and stored verbatim as extra status data.

JSON schema

{
 "description": "A status push: a server's periodic heartbeat carrying its self-reported\nhealth.\n\nBesides the reserved `healthy` and `health` keys described here, any\nadditional top-level fields are accepted and stored verbatim as extra\nstatus data.",
 "allOf": [
   {
     "description": "Free-form additional data (uptime, database version, timezone,\nhostname, etc.). Stored verbatim and surfaced as raw JSON in the\nstatus view.\n\nA `tamanuVersion` field here is used as the server's tracked version\n(compared against the published version catalog), superseding the\nlegacy `X-Version` request header. If both are present,\n`tamanuVersion` wins; if neither is, the status is recorded without a\nversion.",
     "type": "object"
   },
   {
     "type": "object",
     "required": [
       "health"
     ],
     "properties": {
       "health": {
         "description": "Per-check breakdown. **Required** — a push without a `health` array is\nrejected with 400 (unless an operator has opted the server into the\nlegacy format, in which case such a push only refreshes reachability\nand carries the previously reported checks forward). May be empty\n(`[]`) for a server that genuinely runs no checks. Each entry must\ninclude a non-empty `check` name and exactly one of `result` /\n`healthy`; any additional fields per check (latency, free disk %,\ncertificate expiry, etc.) are passed through verbatim and shown in the\nstatus UI.\n\nEvery check name seen — whatever its result — is added to the\noperator-facing check catalog, where the severity assigned to its\nfailures can be reviewed and adjusted. A failed or warning check opens\n(or keeps open) an issue for that check at the catalog's current\nseverity; a broken check opens a separate issue at a fixed Warning\nseverity; passed and skipped results open nothing and close prior\nissues.",
         "type": "array",
         "items": {
           "$ref": "#/components/schemas/HealthCheck"
         }
       },
       "healthy": {
         "description": "Overall self-reported health of the server. **Absent means `true`**,\nso senders that predate this field are never treated as unhealthy by\nomission. Recorded for historical analysis and display, but **not\nconsulted for incident or severity decisions** — those are derived\nfrom the per-check results in `health`, with each check's severity\ncontrolled by an operator-managed catalog.",
         "type": [
           "boolean",
           "null"
         ]
       }
     }
   }
 ]
}

Fields

health: Vec<HealthCheck>

Per-check breakdown. Required — a push without a health array is rejected with 400 (unless an operator has opted the server into the legacy format, in which case such a push only refreshes reachability and carries the previously reported checks forward). May be empty ([]) for a server that genuinely runs no checks. Each entry must include a non-empty check name and exactly one of result / healthy; any additional fields per check (latency, free disk %, certificate expiry, etc.) are passed through verbatim and shown in the status UI.

Every check name seen — whatever its result — is added to the operator-facing check catalog, where the severity assigned to its failures can be reviewed and adjusted. A failed or warning check opens (or keeps open) an issue for that check at the catalog’s current severity; a broken check opens a separate issue at a fixed Warning severity; passed and skipped results open nothing and close prior issues.

healthy: Option<bool>

Overall self-reported health of the server. Absent means true, so senders that predate this field are never treated as unhealthy by omission. Recorded for historical analysis and display, but not consulted for incident or severity decisions — those are derived from the per-check results in health, with each check’s severity controlled by an operator-managed catalog.

Trait Implementations

impl Clone for StatusPayload

fn clone(&self) -> StatusPayload

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StatusPayload

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StatusPayload

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for StatusPayload

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.