Files
archy/scripts/d09-wire-schema.json
T

493 lines
13 KiB
JSON

{
"definitions": {
"os_text": {"kind": "string", "maximum": 128},
"os_status": {
"kind": "object",
"exact_fields": {
"version": "version",
"supported": {"kind": "boolean"},
"plan_sha256": {"kind": "nullable", "of": "digest"},
"phase": {"kind": "enum", "values": ["NO_OS_TRANSACTION", "PREPARE", "DOWNLOAD", "VERIFIED", "APPLY_INTENT", "VERIFY", "REBOOT_REQUIRED", "POSTBOOT_CONFIRMED", "RECONCILIATION_REQUIRED", "UNKNOWN"]},
"installed_os": {"kind": "nullable", "of": "os_text"},
"installed_kernel": {"kind": "nullable", "of": "os_text"},
"running_kernel": {"kind": "nullable", "of": "os_text"},
"reboot_required": {"kind": "nullable", "of": {"kind": "boolean"}},
"post_boot_verified": {"kind": "boolean"}
}
},
"lookup_original": {"kind": "record", "of": "submit_request"},
"lookup_current": {"kind": "record", "of": "inspect_response"},
"acceptance": {
"exact_fields": {
"accepted_sequence": "positive",
"admission_epoch_id": "id",
"composition_digest": "digest",
"grant_digest": "digest",
"operation": "operation",
"request_digest": "digest",
"request_id": "id",
"schema_version": "version",
"target_binding_digest": "digest",
"transaction_id": "id"
},
"kind": "object"
},
"challenge": {
"kind": "hex",
"length": 64,
"nonzero": true
},
"digest": {
"kind": "hex",
"length": 64,
"nonzero": false
},
"executor": {
"exact_fields": {
"boot_id": "id",
"incarnation_id": "id",
"pid": "positive",
"start_ticks": "positive"
},
"kind": "object"
},
"id": {
"kind": "hex",
"length": 32,
"nonzero": true
},
"operation": {
"kind": "enum",
"values": [
"APPLY",
"RECOVER",
"ACK_OBSERVATION"
]
},
"outcome": {
"kind": "enum",
"values": [
"PENDING",
"RECOVERY_REQUIRED",
"COMPLETE"
]
},
"phase": {
"kind": "enum",
"values": [
"RESERVED",
"HANDOFF_READY",
"DISPATCH_INTENT",
"EXECUTING",
"STOP_INTENT",
"STOPPED",
"ACCESS_INTENT",
"ACCESS_PREPARED",
"ACCESS_COMMIT_INTENT",
"ACCESS_COMMITTED",
"CONFIG_INTENT",
"CONFIG_COMMITTED",
"PAYLOAD_INTENT",
"PAYLOAD_COMMITTED",
"RELOAD_INTENT",
"RELOADED",
"START_INTENT",
"REACTIVATION_READY",
"AWAITING_OBSERVATION",
"COMPLETE",
"CLEANUP_INTENT",
"RETAINED",
"CONFLICT",
"READMISSION_REQUIRED"
]
},
"positive": {
"kind": "integer",
"maximum": 9007199254740991,
"minimum": 1
},
"reason": {
"kind": "enum",
"values": [
"NONE",
"APPLY_REQUEST",
"AUTOMATIC_FAILURE",
"MANUAL_REQUEST",
"CRASH_NOTICE",
"BOOT_RECONCILE",
"OBSERVATION_READY",
"MALFORMED",
"AUTHORIZATION",
"TARGET_MISMATCH",
"COMPOSITION_MISMATCH",
"IDEMPOTENCY_MISMATCH",
"STALE_SEQUENCE",
"ACTIVE_TRANSACTION",
"SEQUENCE_EXHAUSTED",
"GRANT_REPLAY",
"GRANT_INVALID",
"AUTHORITY_REVOKED",
"CONTINUITY_REQUIRED",
"INBOX_FULL",
"DISPATCH_PENDING",
"WORKER_LOST",
"FOREIGN_STATE",
"IDENTITY_MISMATCH",
"PARTIAL_RECOVERY",
"OBSERVATION_MISSING",
"INTERNAL_UNCERTAIN",
"UNKNOWN_TRANSACTION"
]
},
"receipt": {
"exact_fields": {
"staging_generation": "id",
"admission_epoch_id": "id",
"backend_restoration": "restoration",
"boot_id": "id",
"composition_digest": "digest",
"config_action": {
"kind": "enum",
"values": [
"NONE",
"APPLY",
"RESTORE"
]
},
"config_current_digest": {
"kind": "nullable",
"of": "digest"
},
"config_post_digest": {
"kind": "nullable",
"of": "digest"
},
"config_pre_digest": {
"kind": "nullable",
"of": "digest"
},
"effective_config_observation_digest": {
"kind": "nullable",
"of": "digest"
},
"executor": {
"kind": "nullable",
"of": "executor"
},
"frontend_restoration": "restoration",
"grant_digest": "digest",
"namespace_observation_digest": {
"kind": "nullable",
"of": "digest"
},
"observed_invocation_id": {
"kind": "nullable",
"of": "id"
},
"operation": "operation",
"outcome": "outcome",
"phase": "phase",
"preservation_observation_digest": {
"kind": "nullable",
"of": "digest"
},
"previous_receipt_digest": {
"kind": "nullable",
"of": "digest"
},
"prior_invocation_id": {
"kind": "nullable",
"of": "id"
},
"reason": "reason",
"request_digest": "digest",
"schema_version": "version",
"sequence": "positive",
"target_binding_digest": "digest",
"transaction_id": "id"
},
"kind": "object"
},
"request_reason": {
"kind": "enum",
"values": [
"APPLY_REQUEST",
"AUTOMATIC_FAILURE",
"MANUAL_REQUEST",
"CRASH_NOTICE",
"BOOT_RECONCILE",
"OBSERVATION_READY"
]
},
"restoration": {
"kind": "enum",
"values": [
"NOT_ATTEMPTED",
"NOT_REQUIRED",
"SUCCEEDED",
"FAILED",
"CONFLICT"
]
},
"route": {
"kind": "enum",
"values": [
"UPDATER",
"AUTOMATIC",
"MANUAL",
"GUARD",
"BOOT",
"OBSERVER"
]
},
"sequence": {
"kind": "integer",
"maximum": 9007199254740991,
"minimum": 0
},
"version": {
"kind": "constant",
"value": 1
}
},
"format": "D09_EXACT_FIELD_GRAMMAR_1",
"max_bytes": 65536,
"max_depth": 8,
"max_unconsumed_inbox_entries": 64,
"notes": [
"All exact_fields are required. Unknown and duplicate keys refuse.",
"Type references name definitions. Enum values are exact strings; constants use type equality.",
"Canonical wire lexical rules and cross-field/authority/lifecycle semantics are normative in semantic_contract.",
"external_readmission_record is installed through existing external coordinator/provisioner authority, never a public submit operation.",
"R1 successor: immutable per-request acceptance and current transaction receipt are separately bound; authenticated contextual checks are mandatory, not replaceable by self-consistent digests."
],
"records": {
"lookup_response": {
"kind": "object",
"exact_fields": {
"schema_version": "version",
"challenge": "challenge",
"request_digest": "digest",
"status": {"kind": "enum", "values": ["FOUND", "UNKNOWN"]},
"acceptance": {"kind": "nullable", "of": "acceptance"},
"current": "lookup_current"
}
},
"lookup_request": {
"kind": "object",
"exact_fields": {
"schema_version": "version",
"challenge": "challenge",
"request_digest": "digest",
"request": "lookup_original"
}
},
"acceptance": "acceptance",
"external_successor_record": {
"kind": "object",
"exact_fields": {
"schema_version": "version",
"target_binding_digest": "digest",
"composition_digest": "digest",
"transaction_id": "id",
"predecessor_epoch_id": "id",
"head_sequence": "positive",
"preserved_head_digest": "digest",
"preserved_journal_digest": "digest",
"preserved_consumed_history_digest": "digest",
"preserved_target_index_digest": "digest",
"external_history_digest": "digest",
"external_history_sequence": "positive",
"successor_binding_digest": "digest",
"observed_boot_id": "id",
"terminal_disposition": {"kind": "enum", "values": ["APPLY", "RESTORE"]}
}
},
"external_activation_record": {
"kind": "object",
"exact_fields": {
"allowed_action": {"kind": "enum", "values": ["REACTIVATE_PREREQUISITE", "REACTIVATE_RETAINED"]},
"composition_digest": "digest",
"execution_grant_digest": "digest",
"external_history_digest": "digest",
"external_history_sequence": "positive",
"head_sequence": "sequence",
"new_epoch_id": "id",
"new_grant_digest": "digest",
"observed_boot_id": "id",
"predecessor_epoch_id": "id",
"preserved_consumed_history_digest": "digest",
"preserved_head_digest": "digest",
"preserved_journal_digest": "digest",
"preserved_target_index_digest": "digest",
"disposition_digest": "digest",
"schema_version": "version",
"target_binding_digest": "digest",
"transaction_id": "id"
}
},
"external_readmission_record": {
"exact_fields": {
"allowed_action": {
"kind": "enum",
"values": [
"RESUME_SAME_TRANSACTION",
"PRESERVE_ONLY"
]
},
"composition_digest": "digest",
"execution_grant_digest": {
"kind": "nullable",
"of": "digest"
},
"external_history_digest": "digest",
"external_history_sequence": "positive",
"head_sequence": "positive",
"new_epoch_id": "id",
"new_grant_digest": "digest",
"observed_boot_id": "id",
"predecessor_epoch_id": "id",
"preserved_consumed_history_digest": "digest",
"preserved_head_digest": "digest",
"preserved_journal_digest": "digest",
"preserved_target_index_digest": "digest",
"schema_version": "version",
"target_binding_digest": "digest",
"transaction_id": "id"
},
"kind": "object"
},
"inspect_request": {
"exact_fields": {
"challenge": "challenge",
"schema_version": "version",
"target_binding_digest": "digest",
"transaction_id": {
"kind": "nullable",
"of": "id"
}
},
"kind": "object"
},
"inspect_response": {
"optional_fields": {"os_update": "os_status"},
"exact_fields": {
"admission_epoch_id": {
"kind": "nullable",
"of": "id"
},
"challenge": "challenge",
"head_digest": {
"kind": "nullable",
"of": "digest"
},
"head_sequence": {
"kind": "nullable",
"of": "sequence"
},
"reason": "reason",
"receipt": {
"kind": "nullable",
"of": "receipt"
},
"receipt_digest": {
"kind": "nullable",
"of": "digest"
},
"schema_version": "version",
"status": {
"kind": "enum",
"values": [
"TRANSACTION",
"NO_D09_TRANSACTION",
"UNKNOWN"
]
},
"target_binding_digest": "digest",
"transaction_id": {
"kind": "nullable",
"of": "id"
}
},
"kind": "object"
},
"receipt": "receipt",
"submit_request": {
"exact_fields": {
"selected_release_digest": {"kind": "nullable", "of": "digest"},
"staging_generation": {"kind": "nullable", "of": "id"},
"composition_digest": "digest",
"expected_sequence": "sequence",
"grant_digest": "digest",
"observer_receipt_digest": {
"kind": "nullable",
"of": "digest"
},
"operation": "operation",
"reason": "request_reason",
"request_id": "id",
"requester_invocation_id": {
"kind": "nullable",
"of": "id"
},
"route": "route",
"schema_version": "version",
"target_binding_digest": "digest",
"transaction_id": "id"
},
"kind": "object"
},
"submit_response": {
"exact_fields": {
"acceptance": {
"kind": "nullable",
"of": "acceptance"
},
"outcome": {
"kind": "enum",
"values": [
"PENDING",
"RECOVERY_REQUIRED",
"COMPLETE",
"REFUSED"
]
},
"reason": "reason",
"receipt": {
"kind": "nullable",
"of": "receipt"
},
"receipt_digest": {
"kind": "nullable",
"of": "digest"
},
"request_digest": {
"kind": "nullable",
"of": "digest"
},
"reservation": {
"kind": "enum",
"values": [
"NONE",
"RETAINED",
"UNKNOWN"
]
},
"schema_version": "version",
"status": {
"kind": "enum",
"values": [
"ACCEPTED",
"REFUSED"
]
}
},
"kind": "object"
}
},
"semantic_contract": "CONTRACT-CORRECTION.md",
"source_owner": "existing_extra41",
"status": "REVIEW_READY_NOT_INDEPENDENTLY_ACCEPTED",
"wire_version": 1
}