JSON Schemas
The SDK generates these schemas from the Pydantic models in oarbank_sdk (oarbank-sdk export-schemas), and its CI
fails when they are stale. Each raw file is served under /oarbank/schemas/. Readers are lenient: the
*.strict.schema.json variants flag unknown fields as probable typos, for authoring checks.
Result envelope 1 is also rendered field by field. Every schema is listed below with a link to its raw file.
75 schemas.
Manifest (2)
Envelopes (2)
Runner protocol (4)
runner-control-1.schema.jsonrunner-doctor-1.schema.jsonrunner-event-1.schema.jsonrunner-failure-1.schema.json
Service protocol (4)
service-fingerprint-1.schema.jsonservice-op-result-1.schema.jsonservice-owned-1.schema.jsonservice-status-1.schema.json
UI contract (2)
Module protocol: messages (3)
module-rpc-notification-1.schema.jsonmodule-rpc-request-1.schema.jsonmodule-rpc-response-1.schema.json
Module protocol: host callbacks (20)
module-host-blobs-stat-params-1.schema.jsonmodule-host-blobs-stat-result-1.schema.jsonmodule-host-datasets-query-params-1.schema.jsonmodule-host-datasets-query-result-1.schema.jsonmodule-host-files-list-params-1.schema.jsonmodule-host-files-list-result-1.schema.jsonmodule-host-files-read-params-1.schema.jsonmodule-host-files-read-result-1.schema.jsonmodule-host-files-stat-params-1.schema.jsonmodule-host-files-stat-result-1.schema.jsonmodule-host-jobs-query-params-1.schema.jsonmodule-host-jobs-query-result-1.schema.jsonmodule-host-nodes-query-params-1.schema.jsonmodule-host-nodes-query-result-1.schema.jsonmodule-host-settings-get-params-1.schema.jsonmodule-host-settings-get-result-1.schema.jsonmodule-host-store-get-params-1.schema.jsonmodule-host-store-get-result-1.schema.jsonmodule-host-store-query-params-1.schema.jsonmodule-host-store-query-result-1.schema.json
Module protocol: verbs (38)
module-campaign-tick-params-1.schema.jsonmodule-campaign-tick-result-1.schema.jsonmodule-golden-compare-params-1.schema.jsonmodule-golden-compare-result-1.schema.jsonmodule-golden-list-params-1.schema.jsonmodule-golden-list-result-1.schema.jsonmodule-initialize-params-1.schema.jsonmodule-initialize-result-1.schema.jsonmodule-integrity-check-params-1.schema.jsonmodule-integrity-check-result-1.schema.jsonmodule-job-plan-params-1.schema.jsonmodule-job-plan-result-1.schema.jsonmodule-move-cancelled-params-1.schema.jsonmodule-move-cancelled-result-1.schema.jsonmodule-move-postflight-params-1.schema.jsonmodule-move-postflight-result-1.schema.jsonmodule-move-preflight-params-1.schema.jsonmodule-move-preflight-result-1.schema.jsonmodule-op-apply-params-1.schema.jsonmodule-op-apply-result-1.schema.jsonmodule-op-plan-params-1.schema.jsonmodule-op-plan-result-1.schema.jsonmodule-params-check-params-1.schema.jsonmodule-params-check-result-1.schema.jsonmodule-params-distance-params-1.schema.jsonmodule-params-distance-result-1.schema.jsonmodule-result-evaluate-params-1.schema.jsonmodule-result-evaluate-result-1.schema.jsonmodule-result-merge-params-1.schema.jsonmodule-result-merge-result-1.schema.jsonmodule-result-upgrade-params-1.schema.jsonmodule-result-upgrade-result-1.schema.jsonmodule-spec-build-params-1.schema.jsonmodule-spec-build-result-1.schema.jsonmodule-study-metrics-params-1.schema.jsonmodule-study-metrics-result-1.schema.jsonmodule-ui-view-compute-params-1.schema.jsonmodule-ui-view-compute-result-1.schema.json