Skip to main content
Read an authoring schema

Authorizations

Authorization
string
header
required

Opaque Firedrill interactive or scoped machine credential. The CLI handles human-approved login; CI stores its scoped credential as FIREDRILL_TOKEN. Capabilities and project/environment ownership are rechecked at use.

Path Parameters

schemaId
string
required
Required string length: 1 - 160

Query Parameters

pointer
string

RFC 6901 pointer, or omit for the root.

sha256
string

Digest returned by the root read; a changed schema returns 409.

Pattern: ^[a-f0-9]{64}$

Response

The retained resource or operation response.

schemaVersion
string
required
Allowed value: "2026-10-15-discovery.1"
contractVersion
string
required
id
enum<string>
required
Available options:
target,
scenario,
rubric,
sequence,
population,
recipe,
target-invocation,
exact-check,
service-binding,
recipe-preview,
scenario-save,
reassessment,
run-intervention,
artifact,
machine-credential,
service-publication,
service-dataset,
service-instance,
service-connection,
dataset-policy,
dataset-metadata,
ci-context,
activity-filters,
composite-policy,
population-purpose,
task-metric,
scenario-recommendation
description
string
required
format
string
required
Allowed value: "json-schema-2020-12"
semantics
string
required
Allowed value: "structural_input_only"
sha256
string
required
pointer
string
required
rootPath
string
required
value
any
required
limitations
string[]
required