schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
sarif-2.1.0.json
translations
Tool translations that will be merged with a separate run.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0.json
addresses
Addresses that will be merged with a separate run.
{"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}
sarif-2.1.0.json
webRequests
Requests that will be merged with a separate run.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0.json
webResponses
Responses that will be merged with a separate run.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0.json
properties
Key/value pairs that provide additional information about the external properties.
{}
sarif-2.1.0.json
externalPropertyFileReference
Contains information that enables a SARIF consumer to locate the external property file that contains the value of an externalized property associated with the run.
{"type": "object", "additionalProperties": false, "properties": {"location": {}, "guid": {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"}, "itemCount": {"type": "integer", "default": -1, "minimum": -1}, "properties": {}}, "anyOf": [{"required": ["location"]}, {"required": ["guid"]}]}
sarif-2.1.0.json
location
The location of the external property file.
{}
sarif-2.1.0.json
guid
A stable, unique identifer for the external property file in the form of a GUID.
{"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"}
sarif-2.1.0.json
itemCount
A non-negative integer specifying the number of items contained in the external property file.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0.json
properties
Key/value pairs that provide additional information about the external property file.
{}
sarif-2.1.0.json
externalPropertyFileReferences
References to external property files that should be inlined with the content of a root log file.
{"additionalProperties": false, "type": "object", "properties": {"conversion": {}, "graphs": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "externalizedProperties": {}, "artifacts": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "invocations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "logicalLocations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "threadFlowLocations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "results": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "taxonomies": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "addresses": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "driver": {}, "extensions": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "policies": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "translations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "webRequests": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "webResponses": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}}
sarif-2.1.0.json
conversion
An external property file containing a run.conversion object to be merged with the root log file.
{}
sarif-2.1.0.json
graphs
An array of external property files containing a run.graphs object to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0.json
externalizedProperties
An external property file containing a run.properties object to be merged with the root log file.
{}
sarif-2.1.0.json
artifacts
An array of external property files containing run.artifacts arrays to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0.json
invocations
An array of external property files containing run.invocations arrays to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0.json
logicalLocations
An array of external property files containing run.logicalLocations arrays to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0.json
threadFlowLocations
An array of external property files containing run.threadFlowLocations arrays to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0.json
results
An array of external property files containing run.results arrays to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0.json
taxonomies
An array of external property files containing run.taxonomies arrays to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0.json
addresses
An array of external property files containing run.addresses arrays to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0.json
driver
An external property file containing a run.driver object to be merged with the root log file.
{}
sarif-2.1.0.json
extensions
An array of external property files containing run.extensions arrays to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0.json
policies
An array of external property files containing run.policies arrays to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0.json
translations
An array of external property files containing run.translations arrays to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0.json
webRequests
An array of external property files containing run.requests arrays to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0.json
webResponses
An array of external property files containing run.responses arrays to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0.json
properties
Key/value pairs that provide additional information about the external property files.
{}
sarif-2.1.0.json
fix
A proposed fix for the problem represented by a result object. A fix specifies a set of artifacts to modify. For each artifact, it specifies a set of bytes to remove, and provides a set of new bytes to replace them.
{"additionalProperties": false, "type": "object", "properties": {"artifactChanges": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "properties": {}}, "required": ["artifactChanges"]}
sarif-2.1.0.json
description
A message that describes the proposed fix, enabling viewers to present the proposed change to an end user.
{}
sarif-2.1.0.json
artifactChanges
One or more artifact changes that comprise a fix for a result.
{"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}
sarif-2.1.0.json
properties
Key/value pairs that provide additional information about the fix.
{}
sarif-2.1.0.json
graph
A network of nodes and directed edges that describes some aspect of the structure of the code (for example, a call graph).
{"type": "object", "additionalProperties": false, "properties": {"nodes": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "edges": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}}
sarif-2.1.0.json
description
A description of the graph.
{}
sarif-2.1.0.json
nodes
An array of node objects representing the nodes of the graph.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0.json
edges
An array of edge objects representing the edges of the graph.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0.json
properties
Key/value pairs that provide additional information about the graph.
{}
sarif-2.1.0.json
graphTraversal
Represents a path through a graph.
{"type": "object", "additionalProperties": false, "properties": {"runGraphIndex": {"type": "integer", "default": -1, "minimum": -1}, "resultGraphIndex": {"type": "integer", "default": -1, "minimum": -1}, "initialState": {"type": "object", "additionalProperties": {}}, "immutableState": {"type": "object", "additionalProperties": {}}, "edgeTraversals": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "properties": {}}, "oneOf": [{"required": ["runGraphIndex"]}, {"required": ["resultGraphIndex"]}]}
sarif-2.1.0.json
runGraphIndex
The index within the run.graphs to be associated with the result.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0.json
resultGraphIndex
The index within the result.graphs to be associated with the result.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0.json
description
A description of this graph traversal.
{}
sarif-2.1.0.json
initialState
Values of relevant expressions at the start of the graph traversal that may change during graph traversal.
{"type": "object", "additionalProperties": {}}
sarif-2.1.0.json
immutableState
Values of relevant expressions at the start of the graph traversal that remain constant for the graph traversal.
{"type": "object", "additionalProperties": {}}
sarif-2.1.0.json
edgeTraversals
The sequences of edges traversed by this graph traversal.
{"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}
sarif-2.1.0.json
properties
Key/value pairs that provide additional information about the graph traversal.
{}
sarif-2.1.0.json
invocation
The runtime environment of the analysis tool run.
{"additionalProperties": false, "type": "object", "properties": {"commandLine": {"type": "string"}, "arguments": {"type": "array", "minItems": 0, "uniqueItems": false, "items": {"type": "string"}}, "responseFiles": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}, "startTimeUtc": {"type": "string", "format": "date-time"}, "endTimeUtc": {"type": "string", "format": "date-time"}, "exitCode": {"type": "integer"}, "ruleConfigurationOverrides": {"type": "array", "minItems": 0, "default": [], "uniqueItems": true, "items": {}}, "notificationConfigurationOverrides": {"type": "array", "minItems": 0, "default": [], "uniqueItems": true, "items": {}}, "toolExecutionNotifications": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "toolConfigurationNotifications": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "exitCodeDescription": {"type": "string"}, "exitSignalName": {"type": "string"}, "exitSignalNumber": {"type": "integer"}, "processStartFailureMessage": {"type": "string"}, "executionSuccessful": {"type": "boolean"}, "machine": {"type": "string"}, "account": {"type": "string"}, "processId": {"type": "integer"}, "executableLocation": {}, "workingDirectory": {}, "environmentVariables": {"type": "object", "additionalProperties": {"type": "string"}}, "stdin": {}, "stdout": {}, "stderr": {}, "stdoutStderr": {}, "properties": {}}, "required": ["executionSuccessful"]}
sarif-2.1.0.json
commandLine
The command line used to invoke the tool.
{"type": "string"}
sarif-2.1.0.json
arguments
An array of strings, containing in order the command line arguments passed to the tool from the operating system.
{"type": "array", "minItems": 0, "uniqueItems": false, "items": {"type": "string"}}
sarif-2.1.0.json
responseFiles
The locations of any response files specified on the tool's command line.
{"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}
sarif-2.1.0.json
startTimeUtc
The Coordinated Universal Time (UTC) date and time at which the invocation started. See "Date/time properties" in the SARIF spec for the required format.
{"type": "string", "format": "date-time"}
sarif-2.1.0.json
endTimeUtc
The Coordinated Universal Time (UTC) date and time at which the invocation ended. See "Date/time properties" in the SARIF spec for the required format.
{"type": "string", "format": "date-time"}
sarif-2.1.0.json
exitCode
The process exit code.
{"type": "integer"}
sarif-2.1.0.json
ruleConfigurationOverrides
An array of configurationOverride objects that describe rules related runtime overrides.
{"type": "array", "minItems": 0, "default": [], "uniqueItems": true, "items": {}}
sarif-2.1.0.json
notificationConfigurationOverrides
An array of configurationOverride objects that describe notifications related runtime overrides.
{"type": "array", "minItems": 0, "default": [], "uniqueItems": true, "items": {}}
sarif-2.1.0.json
toolExecutionNotifications
A list of runtime conditions detected by the tool during the analysis.
{"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}
sarif-2.1.0.json
toolConfigurationNotifications
A list of conditions detected by the tool that are relevant to the tool's configuration.
{"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}
sarif-2.1.0.json
exitCodeDescription
The reason for the process exit.
{"type": "string"}
sarif-2.1.0.json
exitSignalName
The name of the signal that caused the process to exit.
{"type": "string"}
sarif-2.1.0.json
exitSignalNumber
The numeric value of the signal that caused the process to exit.
{"type": "integer"}
sarif-2.1.0.json
processStartFailureMessage
The reason given by the operating system that the process failed to start.
{"type": "string"}
sarif-2.1.0.json
executionSuccessful
Specifies whether the tool's execution completed successfully.
{"type": "boolean"}
sarif-2.1.0.json
machine
The machine on which the invocation occurred.
{"type": "string"}
sarif-2.1.0.json
account
The account under which the invocation occurred.
{"type": "string"}
sarif-2.1.0.json
processId
The id of the process in which the invocation occurred.
{"type": "integer"}
sarif-2.1.0.json
executableLocation
An absolute URI specifying the location of the executable that was invoked.
{}
sarif-2.1.0.json
workingDirectory
The working directory for the invocation.
{}
sarif-2.1.0.json
environmentVariables
The environment variables associated with the analysis tool process, expressed as key/value pairs.
{"type": "object", "additionalProperties": {"type": "string"}}
sarif-2.1.0.json
stdin
A file containing the standard input stream to the process that was invoked.
{}
sarif-2.1.0.json
stdout
A file containing the standard output stream from the process that was invoked.
{}
sarif-2.1.0.json
stderr
A file containing the standard error stream from the process that was invoked.
{}
sarif-2.1.0.json
stdoutStderr
A file containing the interleaved standard output and standard error stream from the process that was invoked.
{}
sarif-2.1.0.json
properties
Key/value pairs that provide additional information about the invocation.
{}
sarif-2.1.0.json
location
A location within a programming artifact.
{"additionalProperties": false, "type": "object", "properties": {"id": {"type": "integer", "minimum": -1, "default": -1}, "physicalLocation": {}, "logicalLocations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "message": {}, "annotations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "relationships": {"type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": {}}, "properties": {}}}
sarif-2.1.0.json
id
Value that distinguishes this location from all other locations within a single result object.
{"type": "integer", "minimum": -1, "default": -1}
sarif-2.1.0.json
physicalLocation
Identifies the artifact and region.
{}
sarif-2.1.0.json
logicalLocations
The logical locations associated with the result.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0.json
message
A message relevant to the location.
{}
sarif-2.1.0.json
annotations
A set of regions relevant to the location.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0.json
relationships
An array of objects that describe relationships between this location and others.
{"type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": {}}
sarif-2.1.0.json
properties
Key/value pairs that provide additional information about the location.
{}
sarif-2.1.0.json
locationRelationship
Information about the relation of one location to another.
{"type": "object", "additionalProperties": false, "properties": {"target": {"type": "integer", "minimum": 0}, "kinds": {"type": "array", "default": ["relevant"], "uniqueItems": true, "items": {"type": "string"}}, "properties": {}}, "required": ["target"]}
sarif-2.1.0.json
target
A reference to the related location.
{"type": "integer", "minimum": 0}
sarif-2.1.0.json
kinds
A set of distinct strings that categorize the relationship. Well-known kinds include 'includes', 'isIncludedBy' and 'relevant'.
{"type": "array", "default": ["relevant"], "uniqueItems": true, "items": {"type": "string"}}
sarif-2.1.0.json
description
A description of the location relationship.
{}
sarif-2.1.0.json
properties
Key/value pairs that provide additional information about the location relationship.
{}
sarif-2.1.0.json
logicalLocation
A logical location of a construct that produced a result.
{"additionalProperties": false, "type": "object", "properties": {"name": {"type": "string"}, "index": {"type": "integer", "default": -1, "minimum": -1}, "fullyQualifiedName": {"type": "string"}, "decoratedName": {"type": "string"}, "parentIndex": {"type": "integer", "default": -1, "minimum": -1}, "kind": {"type": "string"}, "properties": {}}}
sarif-2.1.0.json
name
Identifies the construct in which the result occurred. For example, this property might contain the name of a class or a method.
{"type": "string"}
sarif-2.1.0.json
index
The index within the logical locations array.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0.json
fullyQualifiedName
The human-readable fully qualified name of the logical location.
{"type": "string"}
sarif-2.1.0.json
decoratedName
The machine-readable name for the logical location, such as a mangled function name provided by a C++ compiler that encodes calling convention, return type and other details along with the function name.
{"type": "string"}
sarif-2.1.0.json
parentIndex
Identifies the index of the immediate parent of the construct in which the result was detected. For example, this property might point to a logical location that represents the namespace that holds a type.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0.json
kind
The type of construct this logical location component refers to. Should be one of 'function', 'member', 'module', 'namespace', 'parameter', 'resource', 'returnType', 'type', 'variable', 'object', 'array', 'property', 'value', 'element', 'text', 'attribute', 'comment', 'declaration', 'dtd' or 'processingInstruction', if any of those accurately describe the construct.
{"type": "string"}
sarif-2.1.0.json
properties
Key/value pairs that provide additional information about the logical location.
{}
sarif-2.1.0.json
message
Encapsulates a message intended to be read by the end user.
{"type": "object", "additionalProperties": false, "properties": {"text": {"type": "string"}, "markdown": {"type": "string"}, "id": {"type": "string"}, "arguments": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {"type": "string"}}, "properties": {}}, "anyOf": [{"required": ["text"]}, {"required": ["id"]}]}
sarif-2.1.0.json
text
A plain text message string.
{"type": "string"}
sarif-2.1.0.json
markdown
A Markdown message string.
{"type": "string"}
sarif-2.1.0.json
id
The identifier for this message.
{"type": "string"}
sarif-2.1.0.json
arguments
An array of strings to substitute into the message string.
{"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {"type": "string"}}
sarif-2.1.0.json
properties
Key/value pairs that provide additional information about the message.
{}
sarif-2.1.0.json
multiformatMessageString
A message string or message format string rendered in multiple formats.
{"type": "object", "additionalProperties": false, "properties": {"text": {"type": "string"}, "markdown": {"type": "string"}, "properties": {}}, "required": ["text"]}