Formatter Validator Minifier Escape / Unescape JSON ↔ String JSON ↔ YAML JSON → CSV NDJSON / JSON Lines JSON → Types JSON ↔ XML JSON Diff JSON Patch Canonicalize (RFC 8785) Schema Validator Schema Generator JSONPath Tester JWT Decoder JSON Errors Schemas More Tools
JSONTools / Schema registry / Opctl
Schema registry

Opctl

Opctl describing an op

**/.opspec/*/*.yml**/.opspec/*/*.yaml
Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your **/.opspec/*/*.yml and it validates in your browser — nothing is uploaded.

Validate a **/.opspec/*/*.yml → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field Type Description
namerequiredstringName of the op
descriptionanyDescription of the op
inputsobjectParameter of an op
outputsobjectParameter of an op
runoneOfA single node of the [call graph](https://en.wikipedia.org/wiki/Call_graph)
run.containerobject—
run.container.cmdarrayCommand run by a container; overrides any set at the image level
run.container.dirsobjectDirectories in the container
run.container.envVarsoneOfEnvironment variables in the container
run.container.filesobjectFiles in the container
run.container.imagerequiredobject—
run.container.namearray | boolean | number | object | stringName the container can be referenced by from other containers
run.container.portsobjectPorts bound from the container to the host
run.container.socketsobject—
run.container.workDirstringWorking directory path (overrides any defined by image)
run.ifarray<object>If any predicate evaluates to false, the call will be skipped.
run.opobject—
run.op.inputsobjectInitializes INPUT_NAME from VALUE in format 'INPUT_NAME: VALUE'. If VALUE is null, it MUST be assumed VALUE == $(INPUT_NAME)
run.op.outputsobjectInitializes NAME from OUTPUT_NAME in format 'NAME: OUTPUT_NAME'. If OUTPUT_NAME is null, it MUST be assumed NAME == OUTPUT_NAME
run.op.pullCredsobjectCredentials used during authentication with the source of an image or op
run.op.refrequiredstringReference to an op
run.parallelarray—
run.parallelLoopobjectLoop in which all iterations are called simultaneously.
run.parallelLoop.rangerequiredarray | object | stringRange of the loop, i.e. the value to loop over
run.parallelLoop.runrequiredoneOfA single node of the [call graph](https://en.wikipedia.org/wiki/Call_graph)
run.parallelLoop.varsobjectVariables added to scope on each iteration
run.serialarray—
run.serialLoopobjectLoop in which each iteration gets called sequentially.
run.serialLoop.rangearray | object | stringRange of the loop, i.e. the value to loop over
run.serialLoop.runoneOfA single node of the [call graph](https://en.wikipedia.org/wiki/Call_graph)
run.serialLoop.untilarrayExit condition of the loop; evaluated before each iteration.
run.serialLoop.varsobjectVariables added to scope on each iteration
versionstringVersion of [opspec](https://opspec.io) used by the op
opspecstringVersion of [opspec](https://opspec.io) used by the op
Audit

What we found in this schema

Standards

Specification sections for the keywords in this schema

Keyword Document Section
$idJSON Schema Core, draft 2020-12§8.2.1 — The "$id" Keyword
$refJSON Schema Core, draft 2020-12§8.2.3.1 — Direct References with "$ref"
$schemaJSON Schema Core, draft 2020-12§8.1.1 — "$schema"
additionalPropertiesJSON Schema Core, draft 2020-12§10.3.2.3 — "additionalProperties"
allOfJSON Schema Core, draft 2020-12§10.2.1.1 — "allOf"
anyOfJSON Schema Core, draft 2020-12§10.2.1.2 — "anyOf"
defaultJSON Schema Validation, draft 2020-12§9.2 — "default"
descriptionJSON Schema Validation, draft 2020-12§9.1 — "title" and "description"
enumJSON Schema Validation, draft 2020-12§6.1.2 — "enum"
formatJSON Schema Validation, draft 2020-12§7 — Vocabularies for Semantic Content With "format"
itemsJSON Schema Core, draft 2020-12§10.3.1.2 — "items"
minimumJSON Schema Validation, draft 2020-12§6.2.4 — "minimum"
notJSON Schema Core, draft 2020-12§10.2.1.4 — "not"
oneOfJSON Schema Core, draft 2020-12§10.2.1.3 — "oneOf"
patternJSON Schema Validation, draft 2020-12§6.3.3 — "pattern"
patternPropertiesJSON Schema Core, draft 2020-12§10.3.2.2 — "patternProperties"
propertiesJSON Schema Core, draft 2020-12§10.3.2.1 — "properties"
requiredJSON Schema Validation, draft 2020-12§6.5.3 — "required"
typeJSON Schema Validation, draft 2020-12§6.1.1 — "type"
format: "uri-reference"RFC 3986 (STD 66)§4.1 — URI Reference

Documents

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas