# JSON Schemas

> Every JSON Schema the Oarbank SDK publishes, generated from its typed Python models, with links to the raw files.

HTML version: https://docs.codonic.dev/oarbank/reference/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](/oarbank/reference/schemas/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)

- [`manifest-1.schema.json`](/oarbank/schemas/manifest-1.schema.json)
- [`manifest-1.strict.schema.json`](/oarbank/schemas/manifest-1.strict.schema.json)

### Envelopes (2)

- [`result-envelope-1.schema.json`](/oarbank/schemas/result-envelope-1.schema.json)
- [`spec-envelope-1.schema.json`](/oarbank/schemas/spec-envelope-1.schema.json)

### Runner protocol (4)

- [`runner-control-1.schema.json`](/oarbank/schemas/runner-control-1.schema.json)
- [`runner-doctor-1.schema.json`](/oarbank/schemas/runner-doctor-1.schema.json)
- [`runner-event-1.schema.json`](/oarbank/schemas/runner-event-1.schema.json)
- [`runner-failure-1.schema.json`](/oarbank/schemas/runner-failure-1.schema.json)

### Service protocol (4)

- [`service-fingerprint-1.schema.json`](/oarbank/schemas/service-fingerprint-1.schema.json)
- [`service-op-result-1.schema.json`](/oarbank/schemas/service-op-result-1.schema.json)
- [`service-owned-1.schema.json`](/oarbank/schemas/service-owned-1.schema.json)
- [`service-status-1.schema.json`](/oarbank/schemas/service-status-1.schema.json)

### UI contract (2)

- [`ui-page-1.schema.json`](/oarbank/schemas/ui-page-1.schema.json)
- [`ui-page-1.strict.schema.json`](/oarbank/schemas/ui-page-1.strict.schema.json)

### Module protocol: messages (3)

- [`module-rpc-notification-1.schema.json`](/oarbank/schemas/module-rpc-notification-1.schema.json)
- [`module-rpc-request-1.schema.json`](/oarbank/schemas/module-rpc-request-1.schema.json)
- [`module-rpc-response-1.schema.json`](/oarbank/schemas/module-rpc-response-1.schema.json)

### Module protocol: host callbacks (20)

- [`module-host-blobs-stat-params-1.schema.json`](/oarbank/schemas/module-host-blobs-stat-params-1.schema.json)
- [`module-host-blobs-stat-result-1.schema.json`](/oarbank/schemas/module-host-blobs-stat-result-1.schema.json)
- [`module-host-datasets-query-params-1.schema.json`](/oarbank/schemas/module-host-datasets-query-params-1.schema.json)
- [`module-host-datasets-query-result-1.schema.json`](/oarbank/schemas/module-host-datasets-query-result-1.schema.json)
- [`module-host-files-list-params-1.schema.json`](/oarbank/schemas/module-host-files-list-params-1.schema.json)
- [`module-host-files-list-result-1.schema.json`](/oarbank/schemas/module-host-files-list-result-1.schema.json)
- [`module-host-files-read-params-1.schema.json`](/oarbank/schemas/module-host-files-read-params-1.schema.json)
- [`module-host-files-read-result-1.schema.json`](/oarbank/schemas/module-host-files-read-result-1.schema.json)
- [`module-host-files-stat-params-1.schema.json`](/oarbank/schemas/module-host-files-stat-params-1.schema.json)
- [`module-host-files-stat-result-1.schema.json`](/oarbank/schemas/module-host-files-stat-result-1.schema.json)
- [`module-host-jobs-query-params-1.schema.json`](/oarbank/schemas/module-host-jobs-query-params-1.schema.json)
- [`module-host-jobs-query-result-1.schema.json`](/oarbank/schemas/module-host-jobs-query-result-1.schema.json)
- [`module-host-nodes-query-params-1.schema.json`](/oarbank/schemas/module-host-nodes-query-params-1.schema.json)
- [`module-host-nodes-query-result-1.schema.json`](/oarbank/schemas/module-host-nodes-query-result-1.schema.json)
- [`module-host-settings-get-params-1.schema.json`](/oarbank/schemas/module-host-settings-get-params-1.schema.json)
- [`module-host-settings-get-result-1.schema.json`](/oarbank/schemas/module-host-settings-get-result-1.schema.json)
- [`module-host-store-get-params-1.schema.json`](/oarbank/schemas/module-host-store-get-params-1.schema.json)
- [`module-host-store-get-result-1.schema.json`](/oarbank/schemas/module-host-store-get-result-1.schema.json)
- [`module-host-store-query-params-1.schema.json`](/oarbank/schemas/module-host-store-query-params-1.schema.json)
- [`module-host-store-query-result-1.schema.json`](/oarbank/schemas/module-host-store-query-result-1.schema.json)

### Module protocol: verbs (38)

- [`module-campaign-tick-params-1.schema.json`](/oarbank/schemas/module-campaign-tick-params-1.schema.json)
- [`module-campaign-tick-result-1.schema.json`](/oarbank/schemas/module-campaign-tick-result-1.schema.json)
- [`module-golden-compare-params-1.schema.json`](/oarbank/schemas/module-golden-compare-params-1.schema.json)
- [`module-golden-compare-result-1.schema.json`](/oarbank/schemas/module-golden-compare-result-1.schema.json)
- [`module-golden-list-params-1.schema.json`](/oarbank/schemas/module-golden-list-params-1.schema.json)
- [`module-golden-list-result-1.schema.json`](/oarbank/schemas/module-golden-list-result-1.schema.json)
- [`module-initialize-params-1.schema.json`](/oarbank/schemas/module-initialize-params-1.schema.json)
- [`module-initialize-result-1.schema.json`](/oarbank/schemas/module-initialize-result-1.schema.json)
- [`module-integrity-check-params-1.schema.json`](/oarbank/schemas/module-integrity-check-params-1.schema.json)
- [`module-integrity-check-result-1.schema.json`](/oarbank/schemas/module-integrity-check-result-1.schema.json)
- [`module-job-plan-params-1.schema.json`](/oarbank/schemas/module-job-plan-params-1.schema.json)
- [`module-job-plan-result-1.schema.json`](/oarbank/schemas/module-job-plan-result-1.schema.json)
- [`module-move-cancelled-params-1.schema.json`](/oarbank/schemas/module-move-cancelled-params-1.schema.json)
- [`module-move-cancelled-result-1.schema.json`](/oarbank/schemas/module-move-cancelled-result-1.schema.json)
- [`module-move-postflight-params-1.schema.json`](/oarbank/schemas/module-move-postflight-params-1.schema.json)
- [`module-move-postflight-result-1.schema.json`](/oarbank/schemas/module-move-postflight-result-1.schema.json)
- [`module-move-preflight-params-1.schema.json`](/oarbank/schemas/module-move-preflight-params-1.schema.json)
- [`module-move-preflight-result-1.schema.json`](/oarbank/schemas/module-move-preflight-result-1.schema.json)
- [`module-op-apply-params-1.schema.json`](/oarbank/schemas/module-op-apply-params-1.schema.json)
- [`module-op-apply-result-1.schema.json`](/oarbank/schemas/module-op-apply-result-1.schema.json)
- [`module-op-plan-params-1.schema.json`](/oarbank/schemas/module-op-plan-params-1.schema.json)
- [`module-op-plan-result-1.schema.json`](/oarbank/schemas/module-op-plan-result-1.schema.json)
- [`module-params-check-params-1.schema.json`](/oarbank/schemas/module-params-check-params-1.schema.json)
- [`module-params-check-result-1.schema.json`](/oarbank/schemas/module-params-check-result-1.schema.json)
- [`module-params-distance-params-1.schema.json`](/oarbank/schemas/module-params-distance-params-1.schema.json)
- [`module-params-distance-result-1.schema.json`](/oarbank/schemas/module-params-distance-result-1.schema.json)
- [`module-result-evaluate-params-1.schema.json`](/oarbank/schemas/module-result-evaluate-params-1.schema.json)
- [`module-result-evaluate-result-1.schema.json`](/oarbank/schemas/module-result-evaluate-result-1.schema.json)
- [`module-result-merge-params-1.schema.json`](/oarbank/schemas/module-result-merge-params-1.schema.json)
- [`module-result-merge-result-1.schema.json`](/oarbank/schemas/module-result-merge-result-1.schema.json)
- [`module-result-upgrade-params-1.schema.json`](/oarbank/schemas/module-result-upgrade-params-1.schema.json)
- [`module-result-upgrade-result-1.schema.json`](/oarbank/schemas/module-result-upgrade-result-1.schema.json)
- [`module-spec-build-params-1.schema.json`](/oarbank/schemas/module-spec-build-params-1.schema.json)
- [`module-spec-build-result-1.schema.json`](/oarbank/schemas/module-spec-build-result-1.schema.json)
- [`module-study-metrics-params-1.schema.json`](/oarbank/schemas/module-study-metrics-params-1.schema.json)
- [`module-study-metrics-result-1.schema.json`](/oarbank/schemas/module-study-metrics-result-1.schema.json)
- [`module-ui-view-compute-params-1.schema.json`](/oarbank/schemas/module-ui-view-compute-params-1.schema.json)
- [`module-ui-view-compute-result-1.schema.json`](/oarbank/schemas/module-ui-view-compute-result-1.schema.json)
