schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
opspec-io-0.1.7.json
isSecret
If the directory is secret
{"type": "boolean"}
opspec-io-0.1.7.json
file
File parameter of an op
{"additionalProperties": false, "properties": {"default": {"type": "string"}, "isSecret": {"type": "boolean"}}, "type": "object"}
opspec-io-0.1.7.json
default
Default value; an absolute path rooted at dir containing op.yml or, a relative path interpreted from where the op is started
{"type": "string"}
opspec-io-0.1.7.json
isSecret
If the file is secret
{"type": "boolean"}
opspec-io-0.1.7.json
number
Number parameter of an op
{"additionalProperties": false, "properties": {"default": {"type": "number"}, "isSecret": {"type": "boolean"}, "constraints": {"type": "object", "properties": {"allOf": {"type": "array", "items": {}}, "anyOf": {"type": "array", "items": {}}, "enum": {"type": "array", "items": {"type": "number"}}, "format": {"oneOf": [{"type": "string", "enum": ["integer"]}]}, "maximum": {"type": "number"}, "minimum": {"type": "number"}, "multipleOf": {"type": "number"}, "not": {}, "oneOf": {"type": "array", "items": {}}}, "additionalProperties": false}}, "type": "object"}
opspec-io-0.1.7.json
isSecret
If the number is secret
{"type": "boolean"}
opspec-io-0.1.7.json
properties
JSON Schema [allOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.22)
{"type": "array", "items": {}}
opspec-io-0.1.7.json
properties
JSON Schema [anyOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.23)
{"type": "array", "items": {}}
opspec-io-0.1.7.json
enum
JSON Schema [enum keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.20)
{"type": "array", "items": {"type": "number"}}
opspec-io-0.1.7.json
format
Requires the number be an integer
{"type": "string", "enum": ["integer"]}
opspec-io-0.1.7.json
maximum
JSON Schema [maximum keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.2)
{"type": "number"}
opspec-io-0.1.7.json
minimum
JSON Schema [minimum keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.4)
{"type": "number"}
opspec-io-0.1.7.json
multipleOf
JSON Schema [multipleOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.1)
{"type": "number"}
opspec-io-0.1.7.json
not
JSON Schema [not keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.25)
{}
opspec-io-0.1.7.json
properties
JSON Schema [oneOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.24)
{"type": "array", "items": {}}
opspec-io-0.1.7.json
object
Object parameter of an op
{"additionalProperties": false, "properties": {"default": {"type": "object"}, "isSecret": {"type": "boolean"}, "constraints": {"type": "object", "properties": {"additionalProperties": {"oneOf": [{"type": "boolean"}, {}]}, "allOf": {"type": "array", "items": {}}, "anyOf": {"type": "array", "items": {}}, "dependencies": {"oneOf": [{}, {"items": {"type": "string"}}]}, "enum": {"type": "array", "items": {"type": ["null", "object"]}}, "maxProperties": {"type": "integer", "minimum": 0}, "minProperties": {"type": "integer", "minimum": 0}, "not": {}, "oneOf": {"type": "array", "items": {}}, "properties": {"type": "object", "additionalProperties": {"anyOf": [{"properties": {"type": {"type": ["array", "string"]}, "writeOnly": {"type": "boolean"}}}, {}, {}, {}, {}]}}, "patternProperties": {"type": "object", "additionalProperties": {}}, "required": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false}}, "type": "object"}
opspec-io-0.1.7.json
isSecret
If the object is secret
{"type": "boolean"}
opspec-io-0.1.7.json
additionalProperties
JSON Schema [additionalProperties keyword](https://tools.ietf.org/html/draft-handrews-json-schema-validation-00#section-6.5.6)
{"oneOf": [{"type": "boolean"}, {}]}
opspec-io-0.1.7.json
properties
JSON Schema [allOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.22)
{"type": "array", "items": {}}
opspec-io-0.1.7.json
properties
JSON Schema [anyOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.23)
{"type": "array", "items": {}}
opspec-io-0.1.7.json
dependencies
JSON Schema [dependencies keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.19)
{"oneOf": [{}, {"items": {"type": "string"}}]}
opspec-io-0.1.7.json
enum
JSON Schema [enum keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.20)
{"type": "array", "items": {"type": ["null", "object"]}}
opspec-io-0.1.7.json
maxProperties
JSON Schema [maxProperties keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.13)
{"type": "integer", "minimum": 0}
opspec-io-0.1.7.json
minProperties
JSON Schema [minProperties keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.14)
{"type": "integer", "minimum": 0}
opspec-io-0.1.7.json
not
JSON Schema [not keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.25)
{}
opspec-io-0.1.7.json
properties
JSON Schema [oneOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.24)
{"type": "array", "items": {}}
opspec-io-0.1.7.json
properties
JSON Schema [properties keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.16)
{"type": "object", "additionalProperties": {"anyOf": [{"properties": {"type": {"type": ["array", "string"]}, "writeOnly": {"type": "boolean"}}}, {}, {}, {}, {}]}}
opspec-io-0.1.7.json
additionalProperties
Parameter constraints
{"anyOf": [{"properties": {"type": {"type": ["array", "string"]}, "writeOnly": {"type": "boolean"}}}, {}, {}, {}, {}]}
opspec-io-0.1.7.json
description
JSON Schema [description](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-6.1)
{"type": "string"}
opspec-io-0.1.7.json
title
JSON Schema [title](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-6.1)
{"type": "string"}
opspec-io-0.1.7.json
type
JSON Schema [type](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.21)
{"type": ["array", "string"]}
opspec-io-0.1.7.json
writeOnly
JSON Schema [writeOnly](https://tools.ietf.org/html/draft-handrews-json-schema-validation-00#section-10.3)
{"type": "boolean"}
opspec-io-0.1.7.json
patternProperties
JSON Schema [patternProperties keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.17)
{"type": "object", "additionalProperties": {}}
opspec-io-0.1.7.json
required
JSON Schema [required keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.15)
{"type": "array", "items": {"type": "string"}}
opspec-io-0.1.7.json
socket
Socket parameter of an op
{"additionalProperties": false, "properties": {"isSecret": {"type": "boolean"}}, "type": "object"}
opspec-io-0.1.7.json
isSecret
If the socket is secret
{"type": "boolean"}
opspec-io-0.1.7.json
string
String parameter of an op
{"additionalProperties": false, "properties": {"default": {"type": "string"}, "isSecret": {"type": "boolean"}, "constraints": {"type": "object", "properties": {"allOf": {"type": "array", "items": {}}, "anyOf": {"type": "array", "items": {}}, "enum": {"type": "array", "items": {"type": "string"}}, "format": {"oneOf": [{"type": "string", "enum": ["date-time"]}, {"type": "string", "enum": ["docker-image-ref"]}, {"type": "string", "enum": ["email"]}, {"type": "string", "enum": ["hostname"]}, {"type": "string", "enum": ["ipv4"]}, {"type": "string", "enum": ["ipv6"]}, {"type": "string", "enum": ["uri"]}, {"type": "string", "enum": ["semver"]}]}, "maxLength": {"type": "integer", "minimum": 1}, "minLength": {"type": "integer", "minimum": 0, "default": 0}, "not": {}, "oneOf": {"type": "array", "items": {}}, "pattern": {"type": "string", "format": "regex"}}, "additionalProperties": false}}, "type": "object"}
opspec-io-0.1.7.json
isSecret
If the string is secret
{"type": "boolean"}
opspec-io-0.1.7.json
properties
JSON Schema [allOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.22)
{"type": "array", "items": {}}
opspec-io-0.1.7.json
properties
JSON Schema [anyOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.23)
{"type": "array", "items": {}}
opspec-io-0.1.7.json
enum
JSON Schema [enum keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.20)
{"type": "array", "items": {"type": "string"}}
opspec-io-0.1.7.json
format
Superset of JSON Schema [format keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7)
{"oneOf": [{"type": "string", "enum": ["date-time"]}, {"type": "string", "enum": ["docker-image-ref"]}, {"type": "string", "enum": ["email"]}, {"type": "string", "enum": ["hostname"]}, {"type": "string", "enum": ["ipv4"]}, {"type": "string", "enum": ["ipv6"]}, {"type": "string", "enum": ["uri"]}, {"type": "string", "enum": ["semver"]}]}
opspec-io-0.1.7.json
format
JSON Schema [date-time format](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7.3.1)
{"type": "string", "enum": ["date-time"]}
opspec-io-0.1.7.json
format
A docker image reference as defined by [github.com/docker/distribution/reference](https://github.com/docker/distribution/tree/docker/1.13/reference)
{"type": "string", "enum": ["docker-image-ref"]}
opspec-io-0.1.7.json
format
JSON Schema [email format](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7.3.2)
{"type": "string", "enum": ["email"]}
opspec-io-0.1.7.json
format
JSON Schema [hostname format](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7.3.3)
{"type": "string", "enum": ["hostname"]}
opspec-io-0.1.7.json
format
JSON Schema [ipv4 format](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7.3.4)
{"type": "string", "enum": ["ipv4"]}
opspec-io-0.1.7.json
format
JSON Schema [ipv6 format](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7.3.5)
{"type": "string", "enum": ["ipv6"]}
opspec-io-0.1.7.json
format
JSON Schema [uri format](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7.3.6)
{"type": "string", "enum": ["uri"]}
opspec-io-0.1.7.json
format
A semantic version as defined by [semver.org](http://semver.org/)
{"type": "string", "enum": ["semver"]}
opspec-io-0.1.7.json
maxLength
JSON Schema [maxLength keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.6)
{"type": "integer", "minimum": 1}
opspec-io-0.1.7.json
minLength
JSON Schema [minLength keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.7)
{"type": "integer", "minimum": 0, "default": 0}
opspec-io-0.1.7.json
not
JSON Schema [not keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.25)
{}
opspec-io-0.1.7.json
properties
JSON Schema [oneOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.24)
{"type": "array", "items": {}}
opspec-io-0.1.7.json
pattern
JSON Schema [pattern keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.8)
{"type": "string", "format": "regex"}
opspec-io-0.1.7.json
run
A single node of the [call graph](https://en.wikipedia.org/wiki/Call_graph)
{"additionalProperties": false, "oneOf": [{"required": ["container"]}, {"required": ["op"]}, {"required": ["parallel"]}, {"required": ["parallelLoop"]}, {"required": ["serial"]}, {"required": ["serialLoop"]}], "properties": {"container": {"type": "object", "properties": {"cmd": {"type": "array", "items": {}}, "dirs": {"type": "object", "patternProperties": {"^([a-zA-Z]:)?[-_.\\/a-zA-Z0-9]+$": {"oneOf": [{"type": "null"}, {}]}}, "additionalProperties": false}, "envVars": {"oneOf": [{"additionalProperties": false, "patternProperties": {"^[^=]+$": {"oneOf": [{"type": "null"}, {}]}}, "type": "object"}, {"type": "string", "pattern": "^\\$\\(.+\\)$"}]}, "files": {"type": "object", "patternProperties": {"^([a-zA-Z]:)?[-_.\\/a-zA-Z0-9]+$": {"oneOf": [{"type": "null"}, {}]}}, "additionalProperties": false}, "image": {"type": "object", "properties": {"ref": {}, "pullCreds": {}}, "required": ["ref"], "additionalProperties": false}, "name": {"type": ["array", "boolean", "number", "object", "string"]}, "ports": {"type": "object", "patternProperties": {"[0-9]+(-[0-9]+)?(tcp|udp)?": {"type": ["string", "number"], "pattern": "[0-9]+(-[0-9]+)?"}}, "additionalProperties": false}, "sockets": {"type": "object", "patternProperties": {"[:a-zA-Z0-9]+": {"type": "string"}}, "additionalProperties": false}, "workDir": {"type": "string"}}, "required": ["image"], "additionalProperties": false}, "if": {"type": "array", "items": {"oneOf": [{"required": ["eq"]}, {"required": ["exists"]}, {"required": ["ne"]}, {"required": ["notExists"]}], "properties": {"eq": {"type": "array", "items": {}}, "exists": {"type": "string", "pattern": "^\\$\\(.+\\)$"}, "ne": {"type": "array", "items": {}}, "notExists": {"type": "string", "pattern": "^\\$\\(.+\\)$"}}, "type": "object"}}, "op": {"type": "object", "properties": {"inputs": {"type": "object", "patternProperties": {"[-_.a-zA-Z0-9]+": {"oneOf": [{"type": "null"}, {"type": ["array", "boolean", "number", "object", "string"]}]}}, "additionalProperties": false}, "outputs": {"type": "object", "patternProperties": {"[-_.a-zA-Z0-9]+": {"oneOf": [{"type": "null"}, {"type": "string"}]}}, "additionalProperties": false}, "pullCreds": {"type": "object", "properties": {"username": {}, "password": {}}, "required": ["username", "password"], "additionalProperties": false}, "ref": {"type": "string", "format": "uri-reference"}}, "required": ["ref"], "additionalProperties": false}, "parallel": {"type": "array", "items": {}}, "parallelLoop": {"additionalProperties": false, "properties": {"range": {}, "run": {}, "vars": {}}, "required": ["range", "run"], "type": "object"}, "serial": {"type": "array", "items": {}}, "serialLoop": {"additionalProperties": false, "oneOf": [{"required": ["range", "run"]}, {"required": ["until", "run"]}], "properties": {"range": {"type": ["array", "object", "string"]}, "run": {}, "until": {"type": "array", "items": {}}, "vars": {"additionalProperties": false, "properties": {"index": {}, "key": {"type": "string", "pattern": "^[-_.a-zA-Z0-9]+$"}, "value": {}}, "type": "object"}}, "type": "object"}}}
opspec-io-0.1.7.json
cmd
Command run by a container; overrides any set at the image level
{"type": "array", "items": {}}
opspec-io-0.1.7.json
items
Expression coercible to string value
{}
opspec-io-0.1.7.json
dirs
Directories in the container
{"type": "object", "patternProperties": {"^([a-zA-Z]:)?[-_.\\/a-zA-Z0-9]+$": {"oneOf": [{"type": "null"}, {}]}}, "additionalProperties": false}
opspec-io-0.1.7.json
^([a-zA-Z]:)?[-_.\/a-zA-Z0-9]+$
(will be bound to same path in op)
{"type": "null"}
opspec-io-0.1.7.json
^([a-zA-Z]:)?[-_.\/a-zA-Z0-9]+$
Expression coercible to dir value &/or scope ref to set upon exit
{}
opspec-io-0.1.7.json
envVars
Environment variables in the container
{"oneOf": [{"additionalProperties": false, "patternProperties": {"^[^=]+$": {"oneOf": [{"type": "null"}, {}]}}, "type": "object"}, {"type": "string", "pattern": "^\\$\\(.+\\)$"}]}
opspec-io-0.1.7.json
^[^=]+$
(will be bound to in scope ref w/ same name)
{"type": "null"}
opspec-io-0.1.7.json
^[^=]+$
Expression coercible to string value
{}
opspec-io-0.1.7.json
envVars
Reference to a value
{"type": "string", "pattern": "^\\$\\(.+\\)$"}
opspec-io-0.1.7.json
files
Files in the container
{"type": "object", "patternProperties": {"^([a-zA-Z]:)?[-_.\\/a-zA-Z0-9]+$": {"oneOf": [{"type": "null"}, {}]}}, "additionalProperties": false}
opspec-io-0.1.7.json
^([a-zA-Z]:)?[-_.\/a-zA-Z0-9]+$
(will be bound to same path in op)
{"type": "null"}
opspec-io-0.1.7.json
^([a-zA-Z]:)?[-_.\/a-zA-Z0-9]+$
Expression coercible to file value &/or scope ref to set upon exit
{}
opspec-io-0.1.7.json
ref
Reference to an image
{}
opspec-io-0.1.7.json
name
Name the container can be referenced by from other containers
{"type": ["array", "boolean", "number", "object", "string"]}
opspec-io-0.1.7.json
ports
Ports bound from the container to the host
{"type": "object", "patternProperties": {"[0-9]+(-[0-9]+)?(tcp|udp)?": {"type": ["string", "number"], "pattern": "[0-9]+(-[0-9]+)?"}}, "additionalProperties": false}
opspec-io-0.1.7.json
[0-9]+(-[0-9]+)?(tcp|udp)?
Host port(s) to bind to
{"type": ["string", "number"], "pattern": "[0-9]+(-[0-9]+)?"}
opspec-io-0.1.7.json
[:a-zA-Z0-9]+
Container socket address mapped to a socket ref
{"type": "string"}
opspec-io-0.1.7.json
workDir
Working directory path (overrides any defined by image)
{"type": "string"}
opspec-io-0.1.7.json
if
If any predicate evaluates to false, the call will be skipped.
{"type": "array", "items": {"oneOf": [{"required": ["eq"]}, {"required": ["exists"]}, {"required": ["ne"]}, {"required": ["notExists"]}], "properties": {"eq": {"type": "array", "items": {}}, "exists": {"type": "string", "pattern": "^\\$\\(.+\\)$"}, "ne": {"type": "array", "items": {}}, "notExists": {"type": "string", "pattern": "^\\$\\(.+\\)$"}}, "type": "object"}}
opspec-io-0.1.7.json
items
Condition which evaluates to true or false
{"oneOf": [{"required": ["eq"]}, {"required": ["exists"]}, {"required": ["ne"]}, {"required": ["notExists"]}], "properties": {"eq": {"type": "array", "items": {}}, "exists": {"type": "string", "pattern": "^\\$\\(.+\\)$"}, "ne": {"type": "array", "items": {}}, "notExists": {"type": "string", "pattern": "^\\$\\(.+\\)$"}}, "type": "object"}
opspec-io-0.1.7.json
eq
True if all items are equal
{"type": "array", "items": {}}
opspec-io-0.1.7.json
items
Expression coercible to string value
{}
opspec-io-0.1.7.json
exists
True if value exists w/ reference
{"type": "string", "pattern": "^\\$\\(.+\\)$"}
opspec-io-0.1.7.json
ne
True if any items aren't equal
{"type": "array", "items": {}}
opspec-io-0.1.7.json
items
Expression coercible to string value
{}
opspec-io-0.1.7.json
notExists
True if no value exists w/ reference
{"type": "string", "pattern": "^\\$\\(.+\\)$"}
opspec-io-0.1.7.json
inputs
Initializes INPUT_NAME from VALUE in format 'INPUT_NAME: VALUE'. If VALUE is null, it MUST be assumed VALUE == $(INPUT_NAME)
{"type": "object", "patternProperties": {"[-_.a-zA-Z0-9]+": {"oneOf": [{"type": "null"}, {"type": ["array", "boolean", "number", "object", "string"]}]}}, "additionalProperties": false}
opspec-io-0.1.7.json
[-_.a-zA-Z0-9]+
Expression which evaluates to a value
{"type": ["array", "boolean", "number", "object", "string"]}
opspec-io-0.1.7.json
outputs
Initializes NAME from OUTPUT_NAME in format 'NAME: OUTPUT_NAME'. If OUTPUT_NAME is null, it MUST be assumed NAME == OUTPUT_NAME
{"type": "object", "patternProperties": {"[-_.a-zA-Z0-9]+": {"oneOf": [{"type": "null"}, {"type": "string"}]}}, "additionalProperties": false}
opspec-io-0.1.7.json
pullCreds
Credentials used during authentication with the source of an image or op
{"type": "object", "properties": {"username": {}, "password": {}}, "required": ["username", "password"], "additionalProperties": false}
opspec-io-0.1.7.json
username
Expression coercible to string value
{}
opspec-io-0.1.7.json
password
Expression coercible to string value
{}
opspec-io-0.1.7.json
ref
Reference to an op
{"type": "string", "format": "uri-reference"}
opspec-io-0.1.7.json
parallelLoop
Loop in which all iterations are called simultaneously.
{"additionalProperties": false, "properties": {"range": {}, "run": {}, "vars": {}}, "required": ["range", "run"], "type": "object"}
opspec-io-0.1.7.json
run
What gets run on each iteration of the loop
{}
opspec-io-0.1.7.json
serialLoop
Loop in which each iteration gets called sequentially.
{"additionalProperties": false, "oneOf": [{"required": ["range", "run"]}, {"required": ["until", "run"]}], "properties": {"range": {"type": ["array", "object", "string"]}, "run": {}, "until": {"type": "array", "items": {}}, "vars": {"additionalProperties": false, "properties": {"index": {}, "key": {"type": "string", "pattern": "^[-_.a-zA-Z0-9]+$"}, "value": {}}, "type": "object"}}, "type": "object"}
opspec-io-0.1.7.json
range
Range of the loop, i.e. the value to loop over
{"type": ["array", "object", "string"]}
opspec-io-0.1.7.json
run
What gets run on each iteration of the loop
{}
opspec-io-0.1.7.json
until
Exit condition of the loop; evaluated before each iteration.
{"type": "array", "items": {}}
opspec-io-0.1.7.json
vars
Variables added to scope on each iteration
{"additionalProperties": false, "properties": {"index": {}, "key": {"type": "string", "pattern": "^[-_.a-zA-Z0-9]+$"}, "value": {}}, "type": "object"}
opspec-io-0.1.7.json
index
Variable each iterations associated index will be made available through
{}
opspec-io-0.1.7.json
key
Variable each iterations associated key will be made available through
{"type": "string", "pattern": "^[-_.a-zA-Z0-9]+$"}
opspec-io-0.1.7.json
value
Variable each iterations associated value will be made available through
{}
opspec-io-0.1.7.json
version
Version of the op
{}