Datasets:
dataunitylab
/
json-schema-descriptions

Dataset card Data Studio Files
xet
 Community
1
schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
vercel.json
key
The name of the element contained in the particular type
{"type": "string", "maxLength": 4096}
vercel.json
value
A regular expression used to match the value. Named groups can be used in the destination
{"type": "string", "maxLength": 4096}
vercel.json
missing
An array of requirements that are needed to match
{"type": "array", "maxItems": 16, "items": {"anyOf": [{"type": "object", "additionalProperties": false, "required": ["type", "value"], "properties": {"type": {"type": "string", "enum": ["host"]}, "value": {"type": "string", "maxLength": 4096}}}, {"type": "object", "additionalProperties": false, "required": ["type", "key"], "properties": {"type": {"type": "string", "enum": ["header", "cookie", "query"]}, "key": {"type": "string", "maxLength": 4096}, "value": {"type": "string", "maxLength": 4096}}}]}}
vercel.json
type
The type of request element to check
{"type": "string", "enum": ["host"]}
vercel.json
value
A regular expression used to match the value. Named groups can be used in the destination
{"type": "string", "maxLength": 4096}
vercel.json
type
The type of request element to check
{"type": "string", "enum": ["header", "cookie", "query"]}
vercel.json
key
The name of the element contained in the particular type
{"type": "string", "maxLength": 4096}
vercel.json
value
A regular expression used to match the value. Named groups can be used in the destination
{"type": "string", "maxLength": 4096}
vercel.json
routes
A list of routes objects used to rewrite paths to point towards other internal or external paths
{"type": "array", "maxItems": 1024, "deprecated": true, "example": [{"dest": "https://docs.example.com", "src": "/docs"}], "items": {"anyOf": [{"type": "object", "required": ["src"], "additionalProperties": false, "properties": {"src": {"type": "string", "maxLength": 4096}, "dest": {"type": "string", "maxLength": 4096}, "headers": {"type": "object", "additionalProperties": false, "minProperties": 1, "maxProperties": 100, "patternProperties": {"^.{1,256}$": {"type": "string", "maxLength": 4096}}}, "methods": {"type": "array", "maxItems": 10, "items": {"type": "string", "maxLength": 32}}, "caseSensitive": {"type": "boolean"}, "important": {"type": "boolean"}, "user": {"type": "boolean"}, "continue": {"type": "boolean"}, "override": {"type": "boolean"}, "check": {"type": "boolean"}, "isInternal": {"type": "boolean"}, "status": {"type": "integer", "minimum": 100, "maximum": 999}, "locale": {"type": "object", "additionalProperties": false, "minProperties": 1, "properties": {"redirect": {"type": "object", "additionalProperties": false, "minProperties": 1, "maxProperties": 100, "patternProperties": {"^.{1,256}$": {"type": "string", "maxLength": 4096}}}, "value": {"type": "string", "maxLength": 4096}, "path": {"type": "string", "maxLength": 4096}, "cookie": {"type": "string", "maxLength": 4096}, "default": {"type": "string", "maxLength": 4096}}}, "middleware": {"type": "number"}, "middlewarePath": {"type": "string"}, "middlewareRawSrc": {"type": "array", "items": {"type": "string"}}, "has": {"type": "array", "maxItems": 16, "items": {"anyOf": [{"type": "object", "additionalProperties": false, "required": ["type", "value"], "properties": {"type": {"type": "string", "enum": ["host"]}, "value": {"type": "string", "maxLength": 4096}}}, {"type": "object", "additionalProperties": false, "required": ["type", "key"], "properties": {"type": {"type": "string", "enum": ["header", "cookie", "query"]}, "key": {"type": "string", "maxLength": 4096}, "value": {"type": "string", "maxLength": 4096}}}]}}, "missing": {"type": "array", "maxItems": 16, "items": {"anyOf": [{"type": "object", "additionalProperties": false, "required": ["type", "value"], "properties": {"type": {"type": "string", "enum": ["host"]}, "value": {"type": "string", "maxLength": 4096}}}, {"type": "object", "additionalProperties": false, "required": ["type", "key"], "properties": {"type": {"type": "string", "enum": ["header", "cookie", "query"]}, "key": {"type": "string", "maxLength": 4096}, "value": {"type": "string", "maxLength": 4096}}}]}}}}, {"type": "object", "required": ["handle"], "additionalProperties": false, "properties": {"handle": {"type": "string", "maxLength": 32, "enum": ["error", "filesystem", "hit", "miss", "resource", "rewrite"]}}}]}}
vercel.json
has
An array of requirements that are needed to match
{"type": "array", "maxItems": 16, "items": {"anyOf": [{"type": "object", "additionalProperties": false, "required": ["type", "value"], "properties": {"type": {"type": "string", "enum": ["host"]}, "value": {"type": "string", "maxLength": 4096}}}, {"type": "object", "additionalProperties": false, "required": ["type", "key"], "properties": {"type": {"type": "string", "enum": ["header", "cookie", "query"]}, "key": {"type": "string", "maxLength": 4096}, "value": {"type": "string", "maxLength": 4096}}}]}}
vercel.json
type
The type of request element to check
{"type": "string", "enum": ["host"]}
vercel.json
value
A regular expression used to match the value. Named groups can be used in the destination
{"type": "string", "maxLength": 4096}
vercel.json
type
The type of request element to check
{"type": "string", "enum": ["header", "cookie", "query"]}
vercel.json
key
The name of the element contained in the particular type
{"type": "string", "maxLength": 4096}
vercel.json
value
A regular expression used to match the value. Named groups can be used in the destination
{"type": "string", "maxLength": 4096}
vercel.json
missing
An array of requirements that are needed to match
{"type": "array", "maxItems": 16, "items": {"anyOf": [{"type": "object", "additionalProperties": false, "required": ["type", "value"], "properties": {"type": {"type": "string", "enum": ["host"]}, "value": {"type": "string", "maxLength": 4096}}}, {"type": "object", "additionalProperties": false, "required": ["type", "key"], "properties": {"type": {"type": "string", "enum": ["header", "cookie", "query"]}, "key": {"type": "string", "maxLength": 4096}, "value": {"type": "string", "maxLength": 4096}}}]}}
vercel.json
type
The type of request element to check
{"type": "string", "enum": ["host"]}
vercel.json
value
A regular expression used to match the value. Named groups can be used in the destination
{"type": "string", "maxLength": 4096}
vercel.json
type
The type of request element to check
{"type": "string", "enum": ["header", "cookie", "query"]}
vercel.json
key
The name of the element contained in the particular type
{"type": "string", "maxLength": 4096}
vercel.json
value
A regular expression used to match the value. Named groups can be used in the destination
{"type": "string", "maxLength": 4096}
vercel.json
scope
This property determines the scope (user or team) under which the project will be deployed by Vercel CLI.
{"type": "string", "private": true}
vercel.json
trailingSlash
When `false`, visiting a path that ends with a forward slash will respond with a `308` status code and redirect to the path without the trailing slash.
{"type": "boolean"}
vercel.json
buildCommand
The build command for this project. When `null` is used this value will be automatically detected
{"maxLength": 256, "type": ["string", "null"]}
vercel.json
devCommand
The dev command for this project. When `null` is used this value will be automatically detected
{"maxLength": 256, "type": ["string", "null"]}
vercel.json
framework
The framework that is being used for this project. When `null` is used no framework is selected
{"type": ["null", "string"], "enum": ["blitzjs", "nextjs", "gatsby", "remix", "astro", "hexo", "eleventy", "docusaurus-2", "docusaurus", "preact", "solidstart", "dojo", "ember", "vue", "scully", "ionic-angular", "angular", "polymer", "svelte", "sveltekit", "sveltekit-1", "ionic-react", "create-react-app", "gridsome", "umijs", "sapper", "saber", "stencil", "nuxtjs", "redwoodjs", "hugo", "jekyll", "brunch", "middleman", "zola", "hydrogen", "vite", "vitepress", "vuepress", "parcel", "sanity", "storybook", null]}
vercel.json
installCommand
The install command for this project. When `null` is used this value will be automatically detected
{"maxLength": 256, "type": ["string", "null"]}
vercel.json
outputDirectory
The output directory of the project. When `null` is used this value will be automatically detected
{"maxLength": 256, "type": ["string", "null"]}
vercel.json
crons
An array of cron jobs that should be created for production Deployments.
{"type": "array", "maxItems": 20, "items": {"type": "object", "required": ["schedule", "path"], "properties": {"schedule": {"type": "string", "minLength": 9, "maxLength": 256}, "path": {"type": "string", "maxLength": 512, "pattern": "^/.*"}}}}
workflows.json
Orchestrate Workflows consisting of Google Cloud APIs, SaaS APIs or private API endpoints.
{"$schema": "http://json-schema.org/draft-07/schema#", "definitions": {"subworkflow": {"type": "object", "additionalProperties": false, "properties": {"params": {"type": "array", "minItems": 0, "maxItems": 10, "uniqueItems": true}, "steps": {}}}, "stepArray": {"type": "array", "minItems": 1, "maxItems": 100000, "items": {"type": "object", "minProperties": 1, "maxProperties": 1, "additionalProperties": false, "patternProperties": {"^.*$": {}}}}, "step": {"type": "object", "additionalProperties": false, "dependencies": {"args": ["call"], "result": ["call"], "except": ["try"], "retry": ["try"]}, "properties": {"assign": {}, "call": {}, "args": {}, "result": {}, "next": {}, "switch": {}, "for": {}, "parallel": {}, "raise": {}, "try": {}, "retry": {}, "except": {}, "return": {}, "steps": {}}}, "assign": {"type": "array", "items": {"type": "object", "minProperties": 1, "maxProperties": 1}, "minItems": 1, "maxItems": 50}, "call": {"anyOf": [{"type": "string", "enum": ["http.get", "http.post", "http.put", "http.patch", "http.delete", "http.request"]}, {"type": "string", "enum": ["sys.sleep", "sys.sleep_until", "sys.log"]}, {"type": "string", "enum": ["events.await_callback", "events.create_callback_endpoint"]}, {"type": "string"}, {"type": "string", "pattern": "^googleapis(\\.[a-zA-Z1-9]+)+"}]}, "args": {"type": "object", "additionalProperties": true, "properties": {"url": {"anyOf": [{"type": "string", "format": "uri"}, {"type": "string", "pattern": "^\\$\\{.+\\}$"}]}, "method": {"type": "string", "enum": ["GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"]}, "headers": {"type": "object", "minProperties": 1}, "body": {"anyOf": [{"type": "object"}, {"type": "null"}, {"type": "string"}, {"type": "string", "pattern": "^\\$\\{.+\\}$"}]}, "query": {"anyOf": [{"type": "object"}, {"type": "string", "pattern": "^\\$\\{.+\\}$"}]}, "auth": {"type": "object", "additionalProperties": false, "properties": {"type": {"enum": ["OIDC", "OAuth2"]}, "scope": {"anyOf": [{"type": "array", "contains": {"type": "string"}}, {"type": "string"}]}, "scopes": {}, "audience": {"anyOf": [{"type": "string", "format": "uri"}, {"type": "string", "pattern": "^\\$\\{.+\\}$"}]}}}, "timeout": {"type": "number"}, "connector_params": {"type": "object", "properties": {"timeout": {"type": "integer", "default": 1800, "maximum": 31536000}, "polling_policy": {"type": "object", "properties": {"initial_delay": {"type": "number", "default": 1.0}, "multiplier": {"type": "number", "default": 1.25}, "max_delay": {"type": "number", "default": 60.0}}}, "skip_polling": {"type": "boolean", "default": false}, "scopes": {}}}}}, "result": {}, "next": {"anyOf": [{"type": "string"}, {"type": "string", "const": "end"}, {"type": "string", "const": "continue"}, {"type": "string", "const": "break"}]}, "return": {}, "for": {"type": "object", "additionalProperties": false, "required": ["value", "steps"], "properties": {"value": {"type": "string"}, "index": {"type": "string"}, "in": {"anyOf": [{"type": "array"}, {"type": "string", "pattern": "^\\$\\{.+\\}$"}]}, "range": {"anyOf": [{"type": "array", "items": {"type": "number"}, "minItems": 2, "maxItems": 2}, {"type": "string", "pattern": "^\\$\\{\\[.+\\]\\}$"}]}, "steps": {}}, "oneOf": [{"required": ["in"]}, {"required": ["range"]}]}, "parallel": {"type": "object", "additionalProperties": false, "properties": {"exception_policy": {"type": "string", "const": "continueAll"}, "shared": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "concurrency_limit": {"type": "integer"}, "branches": {}, "for": {}}, "oneOf": [{"required": ["for"]}, {"required": ["branches"]}]}, "branches": {"type": "array", "minItems": 2, "maxItems": 10}, "switch": {"type": "array", "minItems": 1, "maxItems": 50, "items": {}}, "condition": {"type": "object", "required": ["condition"], "properties": {"condition": {"anyOf": [{"type": "string", "pattern": "^\\$\\{.+\\}$"}, {"type": "boolean"}]}, "steps": {}, "assign": {}, "call": {}, "args": {}, "result": {}, "next": {}, "switch": {}, "for": {}, "parallel": {}, "raise": {}, "try": {}, "retry": {}, "except": {}, "return": {}}}, "raise": {"anyOf": [{"type": "string"}, {"type": "object", "properties": {"code": {"type": "integer"}, "message": {"type": "string"}}}]}, "try": {"anyOf": [{}, {}]}, "except": {"type": "object", "additionalProperties": false, "properties": {"as": {"type": "string"}, "steps": {}}}, "retry": {"oneOf": [{"type": "object", "additionalProperties": false, "properties": {"predicate": {"type": "string"}, "max_retries": {"type": "integer"}, "backoff": {"type": "object", "additionalProperties": false, "properties": {"initial_delay": {"type": "integer"}, "max_delay": {"type": "integer"}, "multiplier": {"type": "integer"}}}}}, {"type": "string", "pattern": "^\\$\\{.+\\}$"}]}, "scopes": {"anyOf": [{"type": "array", "contains": {"type": "string"}}, {"type": "string"}, {"type": "string"}]}}, "oneOf": [{"type": "object", "required": ["main"], "properties": {"main": {"type": "object", "additionalProperties": false, "properties": {"params": {"type": "array", "items": {"type": "string"}, "minItems": 0, "maxItems": 1, "uniqueItems": true}, "steps": {}}}}, "additionalProperties": {}}, {}]}
workflows.json
subworkflow
A subworkflow.
{"type": "object", "additionalProperties": false, "properties": {"params": {"type": "array", "minItems": 0, "maxItems": 10, "uniqueItems": true}, "steps": {}}}
workflows.json
params
The name of the parameter variable.
{"type": "array", "minItems": 0, "maxItems": 10, "uniqueItems": true}
workflows.json
steps
An array of objects with a single step.
{}
workflows.json
stepArray
An array of objects with a single step.
{"type": "array", "minItems": 1, "maxItems": 100000, "items": {"type": "object", "minProperties": 1, "maxProperties": 1, "additionalProperties": false, "patternProperties": {"^.*$": {}}}}
workflows.json
items
An object with a single step.
{"type": "object", "minProperties": 1, "maxProperties": 1, "additionalProperties": false, "patternProperties": {"^.*$": {}}}
workflows.json
^.*$
A single workflow step.
{}
workflows.json
step
A single workflow step.
{"type": "object", "additionalProperties": false, "dependencies": {"args": ["call"], "result": ["call"], "except": ["try"], "retry": ["try"]}, "properties": {"assign": {}, "call": {}, "args": {}, "result": {}, "next": {}, "switch": {}, "for": {}, "parallel": {}, "raise": {}, "try": {}, "retry": {}, "except": {}, "return": {}, "steps": {}}}
workflows.json
assign
A list of variable assignment maps.
{"type": "array", "items": {"type": "object", "minProperties": 1, "maxProperties": 1}, "minItems": 1, "maxItems": 50}
workflows.json
items
A single variable assignment.
{"type": "object", "minProperties": 1, "maxProperties": 1}
workflows.json
call
Run a function and return a result.
{"anyOf": [{"type": "string", "enum": ["http.get", "http.post", "http.put", "http.patch", "http.delete", "http.request"]}, {"type": "string", "enum": ["sys.sleep", "sys.sleep_until", "sys.log"]}, {"type": "string", "enum": ["events.await_callback", "events.create_callback_endpoint"]}, {"type": "string"}, {"type": "string", "pattern": "^googleapis(\\.[a-zA-Z1-9]+)+"}]}
workflows.json
call
Standard library module for HTTP/S request support.
{"type": "string", "enum": ["http.get", "http.post", "http.put", "http.patch", "http.delete", "http.request"]}
workflows.json
call
Standard library module for common system interface.
{"type": "string", "enum": ["sys.sleep", "sys.sleep_until", "sys.log"]}
workflows.json
call
Standard library module for event support.
{"type": "string", "enum": ["events.await_callback", "events.create_callback_endpoint"]}
workflows.json
call
A subworkflow.
{"type": "string"}
workflows.json
call
A Google Cloud API connector.
{"type": "string", "pattern": "^googleapis(\\.[a-zA-Z1-9]+)+"}
workflows.json
args
Pass arguments and their values when calling a function that accepts parameters.
{"type": "object", "additionalProperties": true, "properties": {"url": {"anyOf": [{"type": "string", "format": "uri"}, {"type": "string", "pattern": "^\\$\\{.+\\}$"}]}, "method": {"type": "string", "enum": ["GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"]}, "headers": {"type": "object", "minProperties": 1}, "body": {"anyOf": [{"type": "object"}, {"type": "null"}, {"type": "string"}, {"type": "string", "pattern": "^\\$\\{.+\\}$"}]}, "query": {"anyOf": [{"type": "object"}, {"type": "string", "pattern": "^\\$\\{.+\\}$"}]}, "auth": {"type": "object", "additionalProperties": false, "properties": {"type": {"enum": ["OIDC", "OAuth2"]}, "scope": {"anyOf": [{"type": "array", "contains": {"type": "string"}}, {"type": "string"}]}, "scopes": {}, "audience": {"anyOf": [{"type": "string", "format": "uri"}, {"type": "string", "pattern": "^\\$\\{.+\\}$"}]}}}, "timeout": {"type": "number"}, "connector_params": {"type": "object", "properties": {"timeout": {"type": "integer", "default": 1800, "maximum": 31536000}, "polling_policy": {"type": "object", "properties": {"initial_delay": {"type": "number", "default": 1.0}, "multiplier": {"type": "number", "default": 1.25}, "max_delay": {"type": "number", "default": 60.0}}}, "skip_polling": {"type": "boolean", "default": false}, "scopes": {}}}}}
workflows.json
url
URL where the request is sent. Required if using call type http.request.
{"type": "string", "format": "uri"}
workflows.json
url
An expression that results to a URL where the request is sent. Required if using call type http.request.
{"type": "string", "pattern": "^\\$\\{.+\\}$"}
workflows.json
method
The type of HTTP request method to use. Required if using call type http.request.
{"type": "string", "enum": ["GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"]}
workflows.json
headers
Header fields to supply input to the API.
{"type": "object", "minProperties": 1}
workflows.json
body
Body fields to supply input to the API.
{"anyOf": [{"type": "object"}, {"type": "null"}, {"type": "string"}, {"type": "string", "pattern": "^\\$\\{.+\\}$"}]}
workflows.json
query
Query fields to supply input to the API.
{"anyOf": [{"type": "object"}, {"type": "string", "pattern": "^\\$\\{.+\\}$"}]}
workflows.json
auth
Required if the API being called requires authentication.
{"type": "object", "additionalProperties": false, "properties": {"type": {"enum": ["OIDC", "OAuth2"]}, "scope": {"anyOf": [{"type": "array", "contains": {"type": "string"}}, {"type": "string"}]}, "scopes": {}, "audience": {"anyOf": [{"type": "string", "format": "uri"}, {"type": "string", "pattern": "^\\$\\{.+\\}$"}]}}}
workflows.json
type
The type of authentication.
{"enum": ["OIDC", "OAuth2"]}
workflows.json
scope
Specify token scope to limit an application's access to a user's account.
{"anyOf": [{"type": "array", "contains": {"type": "string"}}, {"type": "string"}]}
workflows.json
scope
List of scope strings.
{"type": "array", "contains": {"type": "string"}}
workflows.json
scope
Scope string.
{"type": "string"}
workflows.json
scopes
Specify token scope to limit an application's access to a user's account.
{}
workflows.json
audience
Specifies the audience for the OIDC token. By default, it's set to the same value as url; however, it should be set to your service's root URL.
{"anyOf": [{"type": "string", "format": "uri"}, {"type": "string", "pattern": "^\\$\\{.+\\}$"}]}
workflows.json
timeout
Time in seconds. How long a request is allowed to run before throwing an exception. Default and maximum values vary by call.
{"type": "number"}
workflows.json
connector_params
Connector-specific parameters.
{"type": "object", "properties": {"timeout": {"type": "integer", "default": 1800, "maximum": 31536000}, "polling_policy": {"type": "object", "properties": {"initial_delay": {"type": "number", "default": 1.0}, "multiplier": {"type": "number", "default": 1.25}, "max_delay": {"type": "number", "default": 60.0}}}, "skip_polling": {"type": "boolean", "default": false}, "scopes": {}}}
workflows.json
timeout
Time in seconds. The end-to-end duration the connector call is allowed to run for before throwing a timeout exception.
{"type": "integer", "default": 1800, "maximum": 31536000}
workflows.json
polling_policy
Polling policy.
{"type": "object", "properties": {"initial_delay": {"type": "number", "default": 1.0}, "multiplier": {"type": "number", "default": 1.25}, "max_delay": {"type": "number", "default": 60.0}}}
workflows.json
initial_delay
Time in seconds. Only applies to long-running operation calls.
{"type": "number", "default": 1.0}
workflows.json
multiplier
Time in seconds. Only applies to long-running operation calls.
{"type": "number", "default": 1.25}
workflows.json
max_delay
Time in seconds. Only applies to long-running operation calls.
{"type": "number", "default": 60.0}
workflows.json
skip_polling
If set to True, the connector invocation call is non-blocking if the initial request to manage or update the resource succeeds
{"type": "boolean", "default": false}
workflows.json
scopes
OAuth2 scopes to pass to the Google API.
{}
workflows.json
result
Assign the result from a call to this variable.
{}
workflows.json
next
Define what step Workflows should execute next.
{"anyOf": [{"type": "string"}, {"type": "string", "const": "end"}, {"type": "string", "const": "continue"}, {"type": "string", "const": "break"}]}
workflows.json
next
The step name.
{"type": "string"}
workflows.json
next
Stop a workflow's execution without returning a value.
{"type": "string", "const": "end"}
workflows.json
next
Terminate the current iteration of a for loop and continue with the next iteration.
{"type": "string", "const": "continue"}
workflows.json
next
Terminate iteration of a for loop.
{"type": "string", "const": "break"}
workflows.json
return
Stop a workflow's execution and return a value, variable, or expression.
{}
workflows.json
for
Iterates over a sequence of numbers or through a collection of data, such as a list or map.
{"type": "object", "additionalProperties": false, "required": ["value", "steps"], "properties": {"value": {"type": "string"}, "index": {"type": "string"}, "in": {"anyOf": [{"type": "array"}, {"type": "string", "pattern": "^\\$\\{.+\\}$"}]}, "range": {"anyOf": [{"type": "array", "items": {"type": "number"}, "minItems": 2, "maxItems": 2}, {"type": "string", "pattern": "^\\$\\{\\[.+\\]\\}$"}]}, "steps": {}}, "oneOf": [{"required": ["in"]}, {"required": ["range"]}]}
workflows.json
value
A loop variable name. Contains the value of the currently iterated element.
{"type": "string"}
workflows.json
index
An index variable name. Contains the value to the current offset of the iteration.
{"type": "string"}
workflows.json
in
An expression that evaluates into a list or a list definition. Required, if not using 'range'.
{"anyOf": [{"type": "array"}, {"type": "string", "pattern": "^\\$\\{.+\\}$"}]}
workflows.json
in
A list.
{"type": "array"}
workflows.json
in
An expression that evaluates into a list.
{"type": "string", "pattern": "^\\$\\{.+\\}$"}
workflows.json
range
A list of two expressions, specifying the beginning and end of the range, both inclusive. Required, if not using 'in'.
{"anyOf": [{"type": "array", "items": {"type": "number"}, "minItems": 2, "maxItems": 2}, {"type": "string", "pattern": "^\\$\\{\\[.+\\]\\}$"}]}
workflows.json
range
Array specifying the beginning and end of the range, both inclusive.
{"type": "array", "items": {"type": "number"}, "minItems": 2, "maxItems": 2}
workflows.json
range
The expressions must evaluate into incrementable values; that is, integer or double. Make sure that you do not use multiple expressions inside a list like this: [${rangeStart}, ${rangeEnd}]).
{"type": "string", "pattern": "^\\$\\{\\[.+\\]\\}$"}
workflows.json
steps
Each iteration the steps will be executed.
{}
workflows.json
parallel
Define a part of your workflow where two or more steps can execute concurrently. A 'parallel' step waits until all the steps defined within it have completed or are interrupted by an unhandled exception; execution then continues.
{"type": "object", "additionalProperties": false, "properties": {"exception_policy": {"type": "string", "const": "continueAll"}, "shared": {"type": "array", "uniqueItems": true, "items": {"type": "string"}}, "concurrency_limit": {"type": "integer"}, "branches": {}, "for": {}}, "oneOf": [{"required": ["for"]}, {"required": ["branches"]}]}
workflows.json
exception_policy
The action for other branches when an exception occurs. Optional. The default policy, 'continueAll', results in no further action, and all other branches will attempt to run.
{"type": "string", "const": "continueAll"}
workflows.json
shared
A list of writable variables with parent scope that allow assignments within the 'parallel' step.
{"type": "array", "uniqueItems": true, "items": {"type": "string"}}
workflows.json
concurrency_limit
The maximum number of branches and iterations that can concurrently execute within a single workflow execution before further branches and iterations are queued to wait. This applies to a single 'parallel' step only and does not cascade. Must be a positive integer and can be either a literal value or an expression.
{"type": "integer"}
workflows.json
branches
Branches that can run concurrently. Required, if not using 'for'.
{}
workflows.json
for
A loop where iterations can run concurrently. Required, if not using 'branches'.
{}
workflows.json
branches
Execute parallel branches concurrently and the steps in each branch sequentially.
{"type": "array", "minItems": 2, "maxItems": 10}
workflows.json
switch
A switch block. A selection mechanism that allows the value of an expression to control the flow of a workflow's execution. If a value matches, that condition's statement is executed.
{"type": "array", "minItems": 1, "maxItems": 50, "items": {}}
workflows.json
condition
Define conditional expressions for a switch block.
{"type": "object", "required": ["condition"], "properties": {"condition": {"anyOf": [{"type": "string", "pattern": "^\\$\\{.+\\}$"}, {"type": "boolean"}]}, "steps": {}, "assign": {}, "call": {}, "args": {}, "result": {}, "next": {}, "switch": {}, "for": {}, "parallel": {}, "raise": {}, "try": {}, "retry": {}, "except": {}, "return": {}}}
workflows.json
condition
An expression to switch on.
{"anyOf": [{"type": "string", "pattern": "^\\$\\{.+\\}$"}, {"type": "boolean"}]}
workflows.json
raise
Raise an exception.
{"anyOf": [{"type": "string"}, {"type": "object", "properties": {"code": {"type": "integer"}, "message": {"type": "string"}}}]}
workflows.json
raise
Error message string.
{"type": "string"}
workflows.json
raise
Error message map.
{"type": "object", "properties": {"code": {"type": "integer"}, "message": {"type": "string"}}}
workflows.json
code
Error code.
{"type": "integer"}
workflows.json
message
Error message string.
{"type": "string"}