Skip to content

Package Capability Status Response v1

Source schema: doc/schemas/package-capability-status.response.v1.schema.json

The journal's record of one invocation, or not-found, which is no proof that nothing ran (P093 §13).

Governing Basis

Project Lineage

Fields

Field Required Shape Description
schema yes const: package-capability-status.response.v1
schema/v yes const: 1
invocation/id yes ref: #/$defs/invocation-id
state yes enum: started, completed, aborted, compensated, unknown, not-found
result/status no enum: retained, unavailable
output no unspecified
output/digest no ref: #/$defs/digest
cause no enum: no-outcome, output-contract-violation, pending-disposal

Definitions

Definition Shape Description
digest string
invocation-id string

Conditional Rules

Rule 1

When:

{
  "properties": {
    "state": {
      "const": "completed"
    }
  },
  "required": [
    "state"
  ]
}

Then:

{
  "required": [
    "result/status"
  ],
  "allOf": [
    {
      "not": {
        "anyOf": [
          {
            "required": [
              "cause"
            ]
          }
        ]
      }
    }
  ]
}

Rule 2

When:

{
  "properties": {
    "result/status": {
      "const": "retained"
    }
  },
  "required": [
    "result/status"
  ]
}

Then:

{
  "required": [
    "output",
    "output/digest"
  ]
}

Rule 3

When:

{
  "properties": {
    "state": {
      "const": "unknown"
    }
  },
  "required": [
    "state"
  ]
}

Then:

{
  "required": [
    "cause"
  ]
}

Field Semantics

schema

  • Required: yes
  • Shape: const: package-capability-status.response.v1

schema/v

  • Required: yes
  • Shape: const: 1

invocation/id

  • Required: yes
  • Shape: ref: #/$defs/invocation-id

state

  • Required: yes
  • Shape: enum: started, completed, aborted, compensated, unknown, not-found

result/status

  • Required: no
  • Shape: enum: retained, unavailable

output

  • Required: no
  • Shape: unspecified

output/digest

  • Required: no
  • Shape: ref: #/$defs/digest

cause

  • Required: no
  • Shape: enum: no-outcome, output-contract-violation, pending-disposal

Definition Semantics

$defs.digest

  • Shape: string

$defs.invocation-id

  • Shape: string