schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
sarif-2.0.0.json
hashes
An array of hash objects, each of which specifies a hashed value for the file, along with the name of the hash function used to compute the hash.
{"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}
sarif-2.0.0.json
lastModifiedTime
The date and time at which the file was most recently modified. See "Date/time properties" in the SARIF spec for the required format.
{"type": "string", "format": "date-time"}
sarif-2.0.0.json
properties
Key/value pairs that provide additional information about the file.
{"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}
sarif-2.0.0.json
tags
A set of distinct strings that provide additional information.
{"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}
sarif-2.0.0.json
fileChange
A change to a single file.
{"additionalProperties": false, "type": "object", "properties": {"fileLocation": {}, "replacements": {"type": "array", "minItems": 1, "items": {}}}, "required": ["fileLocation", "replacements"]}
sarif-2.0.0.json
fileLocation
The location of the file to change.
{}
sarif-2.0.0.json
replacements
An array of replacement objects, each of which represents the replacement of a single region in a single file specified by 'fileLocation'.
{"type": "array", "minItems": 1, "items": {}}
sarif-2.0.0.json
fileContent
Represents content from an external file.
{"type": "object", "additionalProperties": false, "properties": {"text": {"type": "string"}, "binary": {"type": "string"}}}
sarif-2.0.0.json
text
UTF-8-encoded content from a text file.
{"type": "string"}
sarif-2.0.0.json
binary
MIME Base64-encoded content from a binary file, or from a text file in its original encoding.
{"type": "string"}
sarif-2.0.0.json
fileLocation
Specifies the location of a file.
{"additionalProperties": false, "type": "object", "properties": {"uri": {"type": "string", "format": "uri-reference"}, "uriBaseId": {"type": "string"}}, "required": ["uri"]}
sarif-2.0.0.json
uri
A string containing a valid relative or absolute URI.
{"type": "string", "format": "uri-reference"}
sarif-2.0.0.json
uriBaseId
A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.
{"type": "string"}
sarif-2.0.0.json
fix
A proposed fix for the problem represented by a result object. A fix specifies a set of file to modify. For each file, it specifies a set of bytes to remove, and provides a set of new bytes to replace them.
{"additionalProperties": false, "type": "object", "properties": {"fileChanges": {"type": "array", "items": {}}}, "required": ["fileChanges"]}
sarif-2.0.0.json
description
A message that describes the proposed fix, enabling viewers to present the proposed change to an end user.
{}
sarif-2.0.0.json
fileChanges
One or more file changes that comprise a fix for a result.
{"type": "array", "items": {}}
sarif-2.0.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": {"id": {"type": "string"}, "nodes": {"type": "array", "items": {}}, "edges": {"type": "array", "items": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["id", "nodes", "edges"]}
sarif-2.0.0.json
id
A string that uniquely identifies the graph within a run.graphs or result.graphs array.
{"type": "string"}
sarif-2.0.0.json
description
A description of the graph.
{}
sarif-2.0.0.json
nodes
An array of node objects representing the nodes of the graph.
{"type": "array", "items": {}}
sarif-2.0.0.json
edges
An array of edge objects representing the edges of the graph.
{"type": "array", "items": {}}
sarif-2.0.0.json
properties
Key/value pairs that provide additional information about the graph.
{"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}
sarif-2.0.0.json
tags
A set of distinct strings that provide additional information.
{"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}
sarif-2.0.0.json
graphTraversal
Represents a path through a graph.
{"type": "object", "additionalProperties": false, "properties": {"graphId": {"type": "string"}, "initialState": {"type": "object", "additionalProperties": {"type": "string"}}, "edgeTraversals": {"type": "array", "items": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["graphId", "edgeTraversals"]}
sarif-2.0.0.json
graphId
A string that uniquely identifies that graph being traversed.
{"type": "string"}
sarif-2.0.0.json
description
A description of this graph traversal.
{}
sarif-2.0.0.json
initialState
Values of relevant expressions at the start of the graph traversal.
{"type": "object", "additionalProperties": {"type": "string"}}
sarif-2.0.0.json
edgeTraversals
The sequences of edges traversed by this graph traversal.
{"type": "array", "items": {}}
sarif-2.0.0.json
properties
Key/value pairs that provide additional information about the graph traversal.
{"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}
sarif-2.0.0.json
tags
A set of distinct strings that provide additional information.
{"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}
sarif-2.0.0.json
hash
A hash value of some file or collection of files, together with the hash function used to compute the hash.
{"additionalProperties": false, "type": "object", "properties": {"value": {"type": "string"}, "algorithm": {"type": "string"}}, "required": ["value", "algorithm"]}
sarif-2.0.0.json
value
The hash value of some file or collection of files, computed by the hash function named in the 'algorithm' property.
{"type": "string"}
sarif-2.0.0.json
algorithm
The name of the hash function used to compute the hash value specified in the 'value' property.
{"type": "string"}
sarif-2.0.0.json
invocation
The runtime environment of the analysis tool run.
{"additionalProperties": false, "type": "object", "properties": {"commandLine": {"type": "string"}, "arguments": {"type": "array", "items": {"type": "string"}}, "responseFiles": {"type": "array", "items": {}}, "attachments": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "startTime": {"type": "string", "format": "date-time"}, "endTime": {"type": "string", "format": "date-time"}, "exitCode": {"type": "integer"}, "toolNotifications": {"type": "array", "items": {}}, "configurationNotifications": {"type": "array", "items": {}}, "exitCodeDescription": {"type": "string"}, "exitSignalName": {"type": "string"}, "exitSignalNumber": {"type": "integer"}, "processStartFailureMessage": {"type": "string"}, "toolExecutionSuccessful": {"type": "boolean"}, "machine": {"type": "string"}, "account": {"type": "string"}, "processId": {"type": "integer"}, "executableLocation": {}, "workingDirectory": {}, "environmentVariables": {"type": "object", "additionalProperties": true, "default": {}}, "stdin": {}, "stdout": {}, "stderr": {}, "stdoutStderr": {}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}}
sarif-2.0.0.json
commandLine
The command line used to invoke the tool.
{"type": "string"}
sarif-2.0.0.json
arguments
An array of strings, containing in order the command line arguments passed to the tool from the operating system.
{"type": "array", "items": {"type": "string"}}
sarif-2.0.0.json
responseFiles
The locations of any response files specified on the tool's command line.
{"type": "array", "items": {}}
sarif-2.0.0.json
attachments
A set of files relevant to the invocation of the tool.
{"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}
sarif-2.0.0.json
startTime
The 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.0.0.json
endTime
The 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.0.0.json
exitCode
The process exit code.
{"type": "integer"}
sarif-2.0.0.json
toolNotifications
A list of runtime conditions detected by the tool during the analysis.
{"type": "array", "items": {}}
sarif-2.0.0.json
configurationNotifications
A list of conditions detected by the tool that are relevant to the tool's configuration.
{"type": "array", "items": {}}
sarif-2.0.0.json
exitCodeDescription
The reason for the process exit.
{"type": "string"}
sarif-2.0.0.json
exitSignalName
The name of the signal that caused the process to exit.
{"type": "string"}
sarif-2.0.0.json
exitSignalNumber
The numeric value of the signal that caused the process to exit.
{"type": "integer"}
sarif-2.0.0.json
processStartFailureMessage
The reason given by the operating system that the process failed to start.
{"type": "string"}
sarif-2.0.0.json
toolExecutionSuccessful
A value indicating whether the tool's execution completed successfully.
{"type": "boolean"}
sarif-2.0.0.json
machine
The machine that hosted the analysis tool run.
{"type": "string"}
sarif-2.0.0.json
account
The account that ran the analysis tool.
{"type": "string"}
sarif-2.0.0.json
processId
The process id for the analysis tool run.
{"type": "integer"}
sarif-2.0.0.json
executableLocation
An absolute URI specifying the location of the analysis tool's executable.
{}
sarif-2.0.0.json
workingDirectory
The working directory for the analysis tool run.
{}
sarif-2.0.0.json
environmentVariables
The environment variables associated with the analysis tool process, expressed as key/value pairs.
{"type": "object", "additionalProperties": true, "default": {}}
sarif-2.0.0.json
stdin
A file containing the standard input stream to the process that was invoked.
{}
sarif-2.0.0.json
stdout
A file containing the standard output stream from the process that was invoked.
{}
sarif-2.0.0.json
stderr
A file containing the standard error stream from the process that was invoked.
{}
sarif-2.0.0.json
stdoutStderr
A file containing the interleaved standard output and standard error stream from the process that was invoked.
{}
sarif-2.0.0.json
properties
Key/value pairs that provide additional information about the invocation.
{"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}
sarif-2.0.0.json
tags
A set of distinct strings that provide additional information.
{"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}
sarif-2.0.0.json
location
A location within a programming artifact.
{"additionalProperties": false, "type": "object", "properties": {"physicalLocation": {}, "fullyQualifiedLogicalName": {"type": "string"}, "message": {}, "annotations": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}}
sarif-2.0.0.json
physicalLocation
Identifies the file and region.
{}
sarif-2.0.0.json
fullyQualifiedLogicalName
The human-readable fully qualified name of the logical location. If run.logicalLocations is present, this value matches a property name within that object, from which further information about the logical location can be obtained.
{"type": "string"}
sarif-2.0.0.json
message
A message relevant to the location.
{}
sarif-2.0.0.json
annotations
A set of regions relevant to the location.
{"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}
sarif-2.0.0.json
properties
Key/value pairs that provide additional information about the location.
{"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}
sarif-2.0.0.json
tags
A set of distinct strings that provide additional information.
{"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}
sarif-2.0.0.json
logicalLocation
A logical location of a construct that produced a result.
{"additionalProperties": false, "type": "object", "properties": {"name": {"type": "string"}, "fullyQualifiedName": {"type": "string"}, "decoratedName": {"type": "string"}, "parentKey": {"type": "string"}, "kind": {"type": "string"}}}
sarif-2.0.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.0.0.json
fullyQualifiedName
The human-readable fully qualified name of the logical location.
{"type": "string"}
sarif-2.0.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.0.0.json
parentKey
Identifies the key 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": "string"}
sarif-2.0.0.json
kind
The type of construct this logicalLocationComponent refers to. Should be one of 'function', 'member', 'module', 'namespace', 'package', 'parameter', 'resource', 'returnType', 'type', or 'variable', if any of those accurately describe the construct.
{"type": "string"}
sarif-2.0.0.json
message
Encapsulates a message intended to be read by the end user.
{"type": "object", "additionalProperties": false, "properties": {"text": {"type": "string"}, "messageId": {"type": "string"}, "richText": {"type": "string"}, "richMessageId": {"type": "string"}, "arguments": {"type": "array", "items": {"type": "string"}}}}
sarif-2.0.0.json
text
A plain text message string.
{"type": "string"}
sarif-2.0.0.json
messageId
The resource id for a plain text message string.
{"type": "string"}
sarif-2.0.0.json
richText
A rich text message string.
{"type": "string"}
sarif-2.0.0.json
richMessageId
The resource id for a rich text message string.
{"type": "string"}
sarif-2.0.0.json
arguments
An array of strings to substitute into the message string.
{"type": "array", "items": {"type": "string"}}
sarif-2.0.0.json
node
Represents a node in a graph.
{"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "label": {}, "location": {}, "children": {"type": "array", "uniqueItems": true, "items": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["id"]}
sarif-2.0.0.json
id
A string that uniquely identifies the node within its graph.
{"type": "string"}
sarif-2.0.0.json
label
A short description of the node.
{}
sarif-2.0.0.json
location
A code location associated with the node.
{}
sarif-2.0.0.json
children
Array of child nodes.
{"type": "array", "uniqueItems": true, "items": {}}
sarif-2.0.0.json
properties
Key/value pairs that provide additional information about the node.
{"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}
sarif-2.0.0.json
tags
A set of distinct strings that provide additional information.
{"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}
sarif-2.0.0.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": {"id": {"type": "string"}, "ruleId": {"type": "string"}, "physicalLocation": {}, "message": {}, "level": {"default": "warning", "enum": ["note", "warning", "error"]}, "threadId": {"type": "integer"}, "time": {"type": "string", "format": "date-time"}, "exception": {}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["message"]}
sarif-2.0.0.json
id
An identifier for the condition that was encountered.
{"type": "string"}
sarif-2.0.0.json
ruleId
The stable, unique identifier of the rule (if any) to which this notification is relevant. This member can be used to retrieve rule metadata from the rules dictionary, if it exists.
{"type": "string"}
sarif-2.0.0.json
physicalLocation
The file and region relevant to this notification.
{}
sarif-2.0.0.json
message
A message that describes the condition that was encountered.
{}
sarif-2.0.0.json
level
A value specifying the severity level of the notification.
{"default": "warning", "enum": ["note", "warning", "error"]}
sarif-2.0.0.json
threadId
The thread identifier of the code that generated the notification.
{"type": "integer"}
sarif-2.0.0.json
time
The date and time at which the analysis tool generated the notification.
{"type": "string", "format": "date-time"}
sarif-2.0.0.json
exception
The runtime exception, if any, relevant to this notification.
{}
sarif-2.0.0.json
properties
Key/value pairs that provide additional information about the notification.
{"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}
sarif-2.0.0.json
tags
A set of distinct strings that provide additional information.
{"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}
sarif-2.0.0.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": {"id": {"type": "integer"}, "fileLocation": {}, "region": {}, "contextRegion": {}}, "required": ["fileLocation"]}
sarif-2.0.0.json
id
Value that distinguishes this physical location from all other physical locations in this run object.
{"type": "integer"}
sarif-2.0.0.json
fileLocation
The location of the file.
{}