schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
sarif-1.0.0.json
result
A result produced by an analysis tool.
{"additionalProperties": false, "type": "object", "properties": {"ruleId": {"type": "string"}, "ruleKey": {"type": "string"}, "level": {"default": "warning", "enum": ["notApplicable", "pass", "note", "warning", "error"]}, "message": {"type": "string"}, "formattedRuleMessage": {}, "locations": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "snippet": {"type": "string"}, "id": {"type": "string"}, "toolFingerprintContribution": {"type": "string"}, "stacks": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "codeFlows": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "relatedLocations": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "suppressionStates": {"type": "array", "items": {"enum": ["suppressedInSource", "suppressedExternally"]}}, "baselineState": {"enum": ["new", "existing", "absent"]}, "fixes": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}}
sarif-1.0.0.json
ruleId
The stable, unique identifier of the rule (if any) to which this notification is relevant. If 'ruleKey' is not specified, this member can be used to retrieve rule metadata from the rules dictionary, if it exists.
{"type": "string"}
sarif-1.0.0.json
ruleKey
A key used to retrieve the rule metadata from the rules dictionary that is relevant to the notification.
{"type": "string"}
sarif-1.0.0.json
level
A value specifying the severity level of the result. If this property is not present, its implied value is 'warning'.
{"default": "warning", "enum": ["notApplicable", "pass", "note", "warning", "error"]}
sarif-1.0.0.json
message
A string that describes the result. The first sentence of the message only will be displayed when visible space is limited.
{"type": "string"}
sarif-1.0.0.json
formattedRuleMessage
A 'formattedRuleMessage' object that can be used to construct a formatted message that describes the result. If the 'formattedMessage' property is present on a result, the 'fullMessage' property shall not be present. If the 'fullMessage' property is present on an result, the 'formattedMessage' property shall not be present
{}
sarif-1.0.0.json
locations
One or more locations where the result occurred. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.
{"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}
sarif-1.0.0.json
snippet
A source code or other file fragment that illustrates the result.
{"type": "string"}
sarif-1.0.0.json
id
A unique identifier for the result.
{"type": "string"}
sarif-1.0.0.json
toolFingerprintContribution
A string that contributes to the unique identity of the result.
{"type": "string"}
sarif-1.0.0.json
stacks
An array of 'stack' objects relevant to the result.
{"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}
sarif-1.0.0.json
codeFlows
An array of 'codeFlow' objects relevant to the result.
{"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}
sarif-1.0.0.json
relatedLocations
A grouped set of locations and messages, if available, that represent code areas that are related to this result.
{"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}
sarif-1.0.0.json
items
A flag value indicating one or more suppression conditions.
{"enum": ["suppressedInSource", "suppressedExternally"]}
sarif-1.0.0.json
baselineState
The state of a result relative to a baseline of a previous run.
{"enum": ["new", "existing", "absent"]}
sarif-1.0.0.json
fixes
An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.
{"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}
sarif-1.0.0.json
properties
Key/value pairs that provide additional information about the result.
{"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}
sarif-1.0.0.json
tags
A set of distinct strings that provide additional information.
{"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}
sarif-1.0.0.json
rule
Describes an analysis rule.
{"additionalProperties": false, "type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "shortDescription": {"type": "string"}, "fullDescription": {"type": "string"}, "messageFormats": {"type": "object"}, "defaultLevel": {"default": "warning", "enum": ["note", "warning", "error"]}, "helpUri": {"type": "string", "format": "uri"}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["id"]}
sarif-1.0.0.json
id
A stable, opaque identifier for the rule.
{"type": "string"}
sarif-1.0.0.json
name
A rule identifier that is understandable to an end user.
{"type": "string"}
sarif-1.0.0.json
shortDescription
A concise description of the rule. Should be a single sentence that is understandable when visible space is limited to a single line of text.
{"type": "string"}
sarif-1.0.0.json
fullDescription
A string that describes the rule. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.
{"type": "string"}
sarif-1.0.0.json
messageFormats
A set of name/value pairs with arbitrary names. The value within each name/value pair shall consist of plain text interspersed with placeholders, which can be used to format a message in combination with an arbitrary number of additional string arguments.
{"type": "object"}
sarif-1.0.0.json
defaultLevel
A value specifying the default severity level of the result.
{"default": "warning", "enum": ["note", "warning", "error"]}
sarif-1.0.0.json
helpUri
A URI where the primary documentation for the rule can be found.
{"type": "string", "format": "uri"}
sarif-1.0.0.json
properties
Key/value pairs that provide additional information about the rule.
{"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}
sarif-1.0.0.json
tags
A set of distinct strings that provide additional information.
{"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}
sarif-1.0.0.json
run
Describes a single run of an analysis tool, and contains the output of that run.
{"additionalProperties": false, "type": "object", "properties": {"tool": {}, "invocation": {}, "files": {"type": "object", "additionalProperties": {}}, "logicalLocations": {"type": "object", "additionalProperties": {}}, "results": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}, "toolNotifications": {"type": "array", "items": {}}, "configurationNotifications": {"type": "array", "items": {}}, "rules": {"type": "object", "additionalProperties": {}}, "id": {"type": "string"}, "stableId": {"type": "string"}, "automationId": {"type": "string"}, "baselineId": {"type": "string"}, "architecture": {"type": "string"}}, "required": ["tool"]}
sarif-1.0.0.json
tool
Information about the tool or tool pipeline that generated the results in this run. A run can only contain results produced by a single tool or tool pipeline. A run can aggregate results from multiple log files, as long as context around the tool run (tool command-line arguments and the like) is identical for all aggregated files.
{}
sarif-1.0.0.json
invocation
Describes the runtime environment, including parameterization, of the analysis tool run.
{}
sarif-1.0.0.json
files
A dictionary, each of whose keys is a URI and each of whose values is an array of file objects representing the location of a single file scanned during the run.
{"type": "object", "additionalProperties": {}}
sarif-1.0.0.json
logicalLocations
A dictionary, each of whose keys specifies a logical location such as a namespace, type or function.
{"type": "object", "additionalProperties": {}}
sarif-1.0.0.json
results
The set of results contained in an SARIF log. The results array can be omitted when a run is solely exporting rules metadata. It must be present (but may be empty) in the event that a log file represents an actual scan.
{"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}
sarif-1.0.0.json
toolNotifications
A list of runtime conditions detected by the tool in the course of the analysis.
{"type": "array", "items": {}}
sarif-1.0.0.json
configurationNotifications
A list of conditions detected by the tool that are relevant to the tool's configuration.
{"type": "array", "items": {}}
sarif-1.0.0.json
rules
A dictionary, each of whose keys is a string and each of whose values is a 'rule' object, that describe all rules associated with an analysis tool or a specific run of an analysis tool.
{"type": "object", "additionalProperties": {}}
sarif-1.0.0.json
id
An identifier for the run.
{"type": "string"}
sarif-1.0.0.json
stableId
A stable identifier for a run, for example, 'nightly Clang analyzer run'. Multiple runs of the same type can have the same stableId.
{"type": "string"}
sarif-1.0.0.json
automationId
A global identifier that allows the run to be correlated with other artifacts produced by a larger automation process.
{"type": "string"}
sarif-1.0.0.json
baselineId
The 'id' property of a separate (potentially external) SARIF 'run' instance that comprises the baseline that was used to compute result 'baselineState' properties for the run.
{"type": "string"}
sarif-1.0.0.json
architecture
The hardware architecture for which the run was targeted.
{"type": "string"}
sarif-1.0.0.json
stack
A call stack that is relevant to a result.
{"additionalProperties": false, "type": "object", "properties": {"message": {"type": "string"}, "frames": {"type": "array", "minItems": 1, "items": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["frames"]}
sarif-1.0.0.json
message
A message relevant to this call stack.
{"type": "string"}
sarif-1.0.0.json
frames
An array of stack frames that represent a sequence of calls, rendered in reverse chronological order, that comprise the call stack.
{"type": "array", "minItems": 1, "items": {}}
sarif-1.0.0.json
properties
Key/value pairs that provide additional information about the stack.
{"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}
sarif-1.0.0.json
tags
A set of distinct strings that provide additional information.
{"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}
sarif-1.0.0.json
stackFrame
A function call within a stack trace.
{"additionalProperties": false, "type": "object", "properties": {"message": {"type": "string"}, "uri": {"type": "string", "format": "uri"}, "uriBaseId": {"type": "string"}, "line": {"type": "integer"}, "column": {"type": "integer"}, "module": {"type": "string"}, "threadId": {"type": "integer"}, "fullyQualifiedLogicalName": {"type": "string"}, "logicalLocationKey": {"type": "string"}, "address": {"type": "integer"}, "offset": {"type": "integer"}, "parameters": {"type": "array", "items": {"type": "string", "default": []}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["fullyQualifiedLogicalName"], "dependencies": {"uriBaseId": ["uri"], "line": ["uri"], "column": ["line"]}}
sarif-1.0.0.json
message
A message relevant to this stack frame.
{"type": "string"}
sarif-1.0.0.json
uri
The uri of the source code file to which this stack frame refers.
{"type": "string", "format": "uri"}
sarif-1.0.0.json
uriBaseId
A string that identifies the conceptual base for the 'uri' property (if it is relative), e.g.,'$(SolutionDir)' or '%SRCROOT%'.
{"type": "string"}
sarif-1.0.0.json
line
The line of the location to which this stack frame refers.
{"type": "integer"}
sarif-1.0.0.json
column
The line of the location to which this stack frame refers.
{"type": "integer"}
sarif-1.0.0.json
module
The name of the module that contains the code of this stack frame.
{"type": "string"}
sarif-1.0.0.json
threadId
The thread identifier of the stack frame.
{"type": "integer"}
sarif-1.0.0.json
fullyQualifiedLogicalName
The fully qualified name of the method or function that is executing.
{"type": "string"}
sarif-1.0.0.json
logicalLocationKey
A key used to retrieve the stack frame logicalLocation from the logicalLocations dictionary, when the 'fullyQualifiedLogicalName' is not unique.
{"type": "string"}
sarif-1.0.0.json
address
The address of the method or function that is executing.
{"type": "integer"}
sarif-1.0.0.json
offset
The offset from the method or function that is executing.
{"type": "integer"}
sarif-1.0.0.json
parameters
The parameters of the call that is executing.
{"type": "array", "items": {"type": "string", "default": []}}
sarif-1.0.0.json
properties
Key/value pairs that provide additional information about the stack frame.
{"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}
sarif-1.0.0.json
tags
A set of distinct strings that provide additional information.
{"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}
sarif-1.0.0.json
tool
The analysis tool that was run.
{"additionalProperties": false, "type": "object", "properties": {"name": {"type": "string"}, "fullName": {"type": "string"}, "version": {"type": "string"}, "semanticVersion": {"type": "string"}, "fileVersion": {"type": "string", "pattern": "[0-9]+(\\.[0-9]+){3}"}, "sarifLoggerVersion": {"type": "string"}, "language": {"type": "string"}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["name"]}
sarif-1.0.0.json
name
The name of the tool.
{"type": "string"}
sarif-1.0.0.json
fullName
The name of the tool along with its version and any other useful identifying information, such as its locale.
{"type": "string"}
sarif-1.0.0.json
version
The tool version, in whatever format the tool natively provides.
{"type": "string"}
sarif-1.0.0.json
semanticVersion
The tool version in the format specified by Semantic Versioning 2.0.
{"type": "string"}
sarif-1.0.0.json
fileVersion
The binary version of the tool's primary executable file (for operating systems such as Windows that provide that information).
{"type": "string", "pattern": "[0-9]+(\\.[0-9]+){3}"}
sarif-1.0.0.json
sarifLoggerVersion
A version that uniquely identifies the SARIF logging component that generated this file, if it is versioned separately from the tool.
{"type": "string"}
sarif-1.0.0.json
language
The tool language (expressed as an ISO 649 two-letter lowercase culture code) and region (expressed as an ISO 3166 two-letter uppercase subculture code associated with a country or region).
{"type": "string"}
sarif-1.0.0.json
properties
Key/value pairs that provide additional information about the tool.
{"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}
sarif-1.0.0.json
tags
A set of distinct strings that provide additional information.
{"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}
sarif-1.0.0.json
$schema
The URI of the JSON schema corresponding to the version.
{"type": "string", "format": "uri"}
sarif-1.0.0.json
version
The SARIF format version of this log file.
{"enum": ["1.0.0"]}
sarif-1.0.0.json
runs
The set of runs contained in this log file.
{"type": "array", "minItems": 1, "items": {}}
schema-catalog.json
schemas
A list of JSON schema references.
{"type": "array", "items": {"type": "object", "required": ["name", "url", "description"], "additionalProperties": false, "properties": {"fileMatch": {"uniqueItems": true, "type": "array", "items": {"type": "string"}}, "url": {"type": "string", "format": "uri", "pattern": "^https://"}, "name": {"type": "string"}, "versions": {"type": "object", "additionalProperties": {"type": "string", "format": "uri", "pattern": "^https://"}}}}}
schema-catalog.json
fileMatch
A Minimatch glob expression for matching up file names with a schema.
{"uniqueItems": true, "type": "array", "items": {"type": "string"}}
schema-catalog.json
url
An absolute URL to the schema location
{"type": "string", "format": "uri", "pattern": "^https://"}
schema-catalog.json
name
The name of the schema
{"type": "string"}
schema-catalog.json
description
A description of the schema
{"type": "string"}
schema-catalog.json
versions
A set of specific version to schema mappings
{"type": "object", "additionalProperties": {"type": "string", "format": "uri", "pattern": "^https://"}}
schema-catalog.json
version
The schema version of the catalog
{"type": "number"}
schema-catalog.json
$schema
Link to https://json.schemastore.org/schema-catalog.json
{"type": "string", "enum": ["https://json.schemastore.org/schema-catalog.json"]}
pathfinder-policy-yml-schema.json
Define the schema for the the Transcend AI Proxy service.
{"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {"enabledIntegrations": {"type": "object", "properties": {"openAI": {"type": "object", "required": ["enabledRoutes"], "properties": {"enabledRoutes": {"type": "array", "items": {"type": "object", "required": ["routeName", "enabledPolicies"], "properties": {"routeName": {"anyOf": [{"const": "/v1/chat/completions"}, {"const": "/v1/embeddings"}]}, "enabledPolicies": {"type": "array", "items": {"anyOf": [{"const": "redactEmail"}, {"const": "log"}]}}}}}}}}}}}
opspec-io-0.1.7.json
Defines an op
{"$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "properties": {"name": {"type": "string"}, "inputs": {"additionalProperties": false, "patternProperties": {"[-_.a-zA-Z0-9]+": {"oneOf": [{"required": ["array"]}, {"required": ["boolean"]}, {"required": ["dir"]}, {"required": ["file"]}, {"required": ["number"]}, {"required": ["object"]}, {"required": ["socket"]}, {"required": ["string"]}], "properties": {"array": {"additionalProperties": false, "properties": {"default": {"type": "array"}, "isSecret": {"type": "boolean"}, "constraints": {"type": "object", "properties": {"additionalItems": {}, "items": {"anyOf": [{}, {"items": {}}]}, "maxItems": {"type": "integer", "minimum": 0}, "minItems": {"type": "integer", "minimum": 0}, "uniqueItems": {"type": "boolean"}}, "additionalProperties": false}}, "type": "object"}, "boolean": {"additionalProperties": false, "properties": {"default": {"type": "boolean"}}, "type": "object"}, "dir": {"additionalProperties": false, "properties": {"default": {"type": "string"}, "isSecret": {"type": "boolean"}}, "type": "object"}, "file": {"additionalProperties": false, "properties": {"default": {"type": "string"}, "isSecret": {"type": "boolean"}}, "type": "object"}, "number": {"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"}, "object": {"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"}, "socket": {"additionalProperties": false, "properties": {"isSecret": {"type": "boolean"}}, "type": "object"}, "string": {"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"}}, "type": "object"}}, "type": "object"}, "outputs": {}, "run": {"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"}}}, "version": {}, "opspec": {"type": "string", "pattern": "^([0-9]+)\\.([0-9]+)\\.([0-9]+)(?:(-[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*))?(?:\\+[0-9A-Za-z-\\-\\.]+)?$"}}, "required": ["name"]}
opspec-io-0.1.7.json
name
Name of the op
{"type": "string"}
opspec-io-0.1.7.json
description
Description of the op
{}
opspec-io-0.1.7.json
inputs
Parameter of an op
{"additionalProperties": false, "patternProperties": {"[-_.a-zA-Z0-9]+": {"oneOf": [{"required": ["array"]}, {"required": ["boolean"]}, {"required": ["dir"]}, {"required": ["file"]}, {"required": ["number"]}, {"required": ["object"]}, {"required": ["socket"]}, {"required": ["string"]}], "properties": {"array": {"additionalProperties": false, "properties": {"default": {"type": "array"}, "isSecret": {"type": "boolean"}, "constraints": {"type": "object", "properties": {"additionalItems": {}, "items": {"anyOf": [{}, {"items": {}}]}, "maxItems": {"type": "integer", "minimum": 0}, "minItems": {"type": "integer", "minimum": 0}, "uniqueItems": {"type": "boolean"}}, "additionalProperties": false}}, "type": "object"}, "boolean": {"additionalProperties": false, "properties": {"default": {"type": "boolean"}}, "type": "object"}, "dir": {"additionalProperties": false, "properties": {"default": {"type": "string"}, "isSecret": {"type": "boolean"}}, "type": "object"}, "file": {"additionalProperties": false, "properties": {"default": {"type": "string"}, "isSecret": {"type": "boolean"}}, "type": "object"}, "number": {"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"}, "object": {"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"}, "socket": {"additionalProperties": false, "properties": {"isSecret": {"type": "boolean"}}, "type": "object"}, "string": {"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"}}, "type": "object"}}, "type": "object"}
opspec-io-0.1.7.json
array
Array parameter of an op
{"additionalProperties": false, "properties": {"default": {"type": "array"}, "isSecret": {"type": "boolean"}, "constraints": {"type": "object", "properties": {"additionalItems": {}, "items": {"anyOf": [{}, {"items": {}}]}, "maxItems": {"type": "integer", "minimum": 0}, "minItems": {"type": "integer", "minimum": 0}, "uniqueItems": {"type": "boolean"}}, "additionalProperties": false}}, "type": "object"}
opspec-io-0.1.7.json
isSecret
If the array is secret
{"type": "boolean"}
opspec-io-0.1.7.json
additionalItems
JSON Schema [additionalItems keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.10)
{}
opspec-io-0.1.7.json
items
JSON Schema [items keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.9)
{"anyOf": [{}, {"items": {}}]}
opspec-io-0.1.7.json
maxItems
JSON Schema [maxItems keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.10)
{"type": "integer", "minimum": 0}
opspec-io-0.1.7.json
minItems
JSON Schema [minItems keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.11)
{"type": "integer", "minimum": 0}
opspec-io-0.1.7.json
uniqueItems
JSON Schema [uniqueItems keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.13)
{"type": "boolean"}
opspec-io-0.1.7.json
boolean
Boolean parameter of an op
{"additionalProperties": false, "properties": {"default": {"type": "boolean"}}, "type": "object"}
opspec-io-0.1.7.json
default
Default value
{"type": "boolean"}
opspec-io-0.1.7.json
dir
Directory parameter of an op
{"additionalProperties": false, "properties": {"default": {"type": "string"}, "isSecret": {"type": "boolean"}}, "type": "object"}
opspec-io-0.1.7.json
description
Markdown in [v0.28 CommonMark syntax](http://spec.commonmark.org/0.28/) including GFM table extension
{"type": "string"}
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"}