Sensorium Interface Status v1¶
Source schema: doc/schemas/sensorium-interface-status.v1.schema.json
Current host projection of an interface publication lifecycle and health.
Fields¶
| Field | Required | Shape | Description |
|---|---|---|---|
schema |
yes |
const: sensorium-interface-status.v1 |
Contract discriminator. |
schema/v |
yes |
const: 1 |
Contract version. |
interface/id |
yes |
string | Interface resource described by this status. |
lifecycle/status |
yes |
enum: published, suspended, withdrawn, expired |
Host-enforced publication lifecycle. |
health/status |
yes |
enum: ready, degraded |
Current ability to serve admitted operations. |
health/reason |
no |
string | Required bounded diagnostic when health is degraded. |
replacement/interface-id |
no |
string | Current replacement, present only after an atomic supersession. |
status/at |
yes |
string | Time this status projection was recorded. |
Conditional Rules¶
Rule 1¶
When:
{
"properties": {
"health/status": {
"const": "degraded"
}
},
"required": [
"health/status"
]
}
Then:
{
"required": [
"health/reason"
]
}
Rule 2¶
When:
{
"required": [
"replacement/interface-id"
]
}
Then:
{
"properties": {
"lifecycle/status": {
"const": "withdrawn"
}
}
}
Field Semantics¶
schema¶
- Required:
yes - Shape: const:
sensorium-interface-status.v1
Contract discriminator.
schema/v¶
- Required:
yes - Shape: const:
1
Contract version.
interface/id¶
- Required:
yes - Shape: string
Interface resource described by this status.
lifecycle/status¶
- Required:
yes - Shape: enum:
published,suspended,withdrawn,expired
Host-enforced publication lifecycle.
health/status¶
- Required:
yes - Shape: enum:
ready,degraded
Current ability to serve admitted operations.
health/reason¶
- Required:
no - Shape: string
Required bounded diagnostic when health is degraded.
replacement/interface-id¶
- Required:
no - Shape: string
Current replacement, present only after an atomic supersession.
status/at¶
- Required:
yes - Shape: string
Time this status projection was recorded.