schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
sarif-2.1.0-rtm.3.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-rtm.3.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-rtm.3.json
properties
Key/value pairs that provide additional information about the graph.
{}
sarif-2.1.0-rtm.3.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-rtm.3.json
runGraphIndex
The index within the run.graphs to be associated with the result.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0-rtm.3.json
resultGraphIndex
The index within the result.graphs to be associated with the result.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0-rtm.3.json
description
A description of this graph traversal.
{}
sarif-2.1.0-rtm.3.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-rtm.3.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-rtm.3.json
edgeTraversals
The sequences of edges traversed by this graph traversal.
{"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the graph traversal.
{}
sarif-2.1.0-rtm.3.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-rtm.3.json
commandLine
The command line used to invoke the tool.
{"type": "string"}
sarif-2.1.0-rtm.3.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-rtm.3.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-rtm.3.json
startTimeUtc
The Coordinated Universal Time (UTC) date and time at which the run started. See "Date/time properties" in the SARIF spec for the required format.
{"type": "string", "format": "date-time"}
sarif-2.1.0-rtm.3.json
endTimeUtc
The Coordinated Universal Time (UTC) date and time at which the run ended. See "Date/time properties" in the SARIF spec for the required format.
{"type": "string", "format": "date-time"}
sarif-2.1.0-rtm.3.json
exitCode
The process exit code.
{"type": "integer"}
sarif-2.1.0-rtm.3.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-rtm.3.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-rtm.3.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-rtm.3.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-rtm.3.json
exitCodeDescription
The reason for the process exit.
{"type": "string"}
sarif-2.1.0-rtm.3.json
exitSignalName
The name of the signal that caused the process to exit.
{"type": "string"}
sarif-2.1.0-rtm.3.json
exitSignalNumber
The numeric value of the signal that caused the process to exit.
{"type": "integer"}
sarif-2.1.0-rtm.3.json
processStartFailureMessage
The reason given by the operating system that the process failed to start.
{"type": "string"}
sarif-2.1.0-rtm.3.json
executionSuccessful
Specifies whether the tool's execution completed successfully.
{"type": "boolean"}
sarif-2.1.0-rtm.3.json
machine
The machine that hosted the analysis tool run.
{"type": "string"}
sarif-2.1.0-rtm.3.json
account
The account that ran the analysis tool.
{"type": "string"}
sarif-2.1.0-rtm.3.json
processId
The process id for the analysis tool run.
{"type": "integer"}
sarif-2.1.0-rtm.3.json
executableLocation
An absolute URI specifying the location of the analysis tool's executable.
{}
sarif-2.1.0-rtm.3.json
workingDirectory
The working directory for the analysis tool run.
{}
sarif-2.1.0-rtm.3.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-rtm.3.json
stdin
A file containing the standard input stream to the process that was invoked.
{}
sarif-2.1.0-rtm.3.json
stdout
A file containing the standard output stream from the process that was invoked.
{}
sarif-2.1.0-rtm.3.json
stderr
A file containing the standard error stream from the process that was invoked.
{}
sarif-2.1.0-rtm.3.json
stdoutStderr
A file containing the interleaved standard output and standard error stream from the process that was invoked.
{}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the invocation.
{}
sarif-2.1.0-rtm.3.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-rtm.3.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-rtm.3.json
physicalLocation
Identifies the artifact and region.
{}
sarif-2.1.0-rtm.3.json
logicalLocations
The logical locations associated with the result.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
message
A message relevant to the location.
{}
sarif-2.1.0-rtm.3.json
annotations
A set of regions relevant to the location.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.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-rtm.3.json
properties
Key/value pairs that provide additional information about the location.
{}
sarif-2.1.0-rtm.3.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-rtm.3.json
target
A reference to the related location.
{"type": "integer", "minimum": 0}
sarif-2.1.0-rtm.3.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-rtm.3.json
description
A description of the location relationship.
{}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the location relationship.
{}
sarif-2.1.0-rtm.3.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-rtm.3.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-rtm.3.json
index
The index within the logical locations array.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0-rtm.3.json
fullyQualifiedName
The human-readable fully qualified name of the logical location.
{"type": "string"}
sarif-2.1.0-rtm.3.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-rtm.3.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-rtm.3.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-rtm.3.json
properties
Key/value pairs that provide additional information about the logical location.
{}
sarif-2.1.0-rtm.3.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-rtm.3.json
text
A plain text message string.
{"type": "string"}
sarif-2.1.0-rtm.3.json
markdown
A Markdown message string.
{"type": "string"}
sarif-2.1.0-rtm.3.json
id
The identifier for this message.
{"type": "string"}
sarif-2.1.0-rtm.3.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-rtm.3.json
properties
Key/value pairs that provide additional information about the message.
{}
sarif-2.1.0-rtm.3.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"]}
sarif-2.1.0-rtm.3.json
text
A plain text message string or format string.
{"type": "string"}
sarif-2.1.0-rtm.3.json
markdown
A Markdown message string or format string.
{"type": "string"}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the message.
{}
sarif-2.1.0-rtm.3.json
node
Represents a node in a graph.
{"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "label": {}, "location": {}, "children": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}, "required": ["id"]}
sarif-2.1.0-rtm.3.json
id
A string that uniquely identifies the node within its graph.
{"type": "string"}
sarif-2.1.0-rtm.3.json
label
A short description of the node.
{}
sarif-2.1.0-rtm.3.json
location
A code location associated with the node.
{}
sarif-2.1.0-rtm.3.json
children
Array of child nodes.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the node.
{}
sarif-2.1.0-rtm.3.json
notification
Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.
{"type": "object", "additionalProperties": false, "properties": {"locations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "message": {}, "level": {"default": "warning", "enum": ["none", "note", "warning", "error"]}, "threadId": {"type": "integer"}, "timeUtc": {"type": "string", "format": "date-time"}, "exception": {}, "descriptor": {}, "associatedRule": {}, "properties": {}}, "required": ["message"]}
sarif-2.1.0-rtm.3.json
locations
The locations relevant to this notification.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
message
A message that describes the condition that was encountered.
{}
sarif-2.1.0-rtm.3.json
level
A value specifying the severity level of the notification.
{"default": "warning", "enum": ["none", "note", "warning", "error"]}
sarif-2.1.0-rtm.3.json
threadId
The thread identifier of the code that generated the notification.
{"type": "integer"}
sarif-2.1.0-rtm.3.json
timeUtc
The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.
{"type": "string", "format": "date-time"}
sarif-2.1.0-rtm.3.json
exception
The runtime exception, if any, relevant to this notification.
{}
sarif-2.1.0-rtm.3.json
descriptor
A reference used to locate the descriptor relevant to this notification.
{}
sarif-2.1.0-rtm.3.json
associatedRule
A reference used to locate the rule descriptor associated with this notification.
{}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the notification.
{}
sarif-2.1.0-rtm.3.json
physicalLocation
A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.
{"additionalProperties": false, "type": "object", "properties": {"address": {}, "artifactLocation": {}, "region": {}, "contextRegion": {}, "properties": {}}, "anyOf": [{"required": ["address"]}, {"required": ["artifactLocation"]}]}
sarif-2.1.0-rtm.3.json
address
The address of the location.
{}
sarif-2.1.0-rtm.3.json
artifactLocation
The location of the artifact.
{}
sarif-2.1.0-rtm.3.json
region
Specifies a portion of the artifact.
{}
sarif-2.1.0-rtm.3.json
contextRegion
Specifies a portion of the artifact that encloses the region. Allows a viewer to display additional context around the region.
{}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the physical location.
{}
sarif-2.1.0-rtm.3.json
propertyBag
Key/value pairs that provide additional information about the object.
{"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {"type": "string"}}}}
sarif-2.1.0-rtm.3.json
tags
A set of distinct strings that provide additional information.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {"type": "string"}}
sarif-2.1.0-rtm.3.json
rectangle
An area within an image.
{"additionalProperties": false, "type": "object", "properties": {"top": {"type": "number"}, "left": {"type": "number"}, "bottom": {"type": "number"}, "right": {"type": "number"}, "message": {}, "properties": {}}}
sarif-2.1.0-rtm.3.json
top
The Y coordinate of the top edge of the rectangle, measured in the image's natural units.
{"type": "number"}
sarif-2.1.0-rtm.3.json
left
The X coordinate of the left edge of the rectangle, measured in the image's natural units.
{"type": "number"}
sarif-2.1.0-rtm.3.json
bottom
The Y coordinate of the bottom edge of the rectangle, measured in the image's natural units.
{"type": "number"}
sarif-2.1.0-rtm.3.json
right
The X coordinate of the right edge of the rectangle, measured in the image's natural units.
{"type": "number"}
sarif-2.1.0-rtm.3.json
message
A message relevant to the rectangle.
{}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the rectangle.
{}