schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
sarif-2.1.0-rtm.6.json
ruleIndex
The index within the tool component rules array of the rule object associated with this result.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0-rtm.6.json
rule
A reference used to locate the rule descriptor relevant to this result.
{}
sarif-2.1.0-rtm.6.json
kind
A value that categorizes results by evaluation state.
{"default": "fail", "enum": ["notApplicable", "pass", "fail", "review", "open", "informational"]}
sarif-2.1.0-rtm.6.json
level
A value specifying the severity level of the result.
{"default": "warning", "enum": ["none", "note", "warning", "error"]}
sarif-2.1.0-rtm.6.json
message
A message that describes the result. The first sentence of the message only will be displayed when visible space is limited.
{}
sarif-2.1.0-rtm.6.json
analysisTarget
Identifies the artifact that the analysis tool was instructed to scan. This need not be the same as the artifact where the result actually occurred.
{}
sarif-2.1.0-rtm.6.json
locations
The set of locations where the result was detected. 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": 0, "uniqueItems": false, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
guid
A stable, unique identifier for the result in the form of a GUID.
{"type": "string", "format": "uuid"}
sarif-2.1.0-rtm.6.json
correlationGuid
A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.
{"type": "string", "format": "uuid"}
sarif-2.1.0-rtm.6.json
occurrenceCount
A positive integer specifying the number of times this logically unique result was observed in this run.
{"type": "integer", "minimum": 1}
sarif-2.1.0-rtm.6.json
partialFingerprints
A set of strings that contribute to the stable, unique identity of the result.
{"type": "object", "additionalProperties": {"type": "string"}}
sarif-2.1.0-rtm.6.json
fingerprints
A set of strings each of which individually defines a stable, unique identity for the result.
{"type": "object", "additionalProperties": {"type": "string"}}
sarif-2.1.0-rtm.6.json
stacks
An array of 'stack' objects relevant to the result.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
codeFlows
An array of 'codeFlow' objects relevant to the result.
{"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
graphs
An array of zero or more unique graph objects associated with the result.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
graphTraversals
An array of one or more unique 'graphTraversal' objects.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
relatedLocations
A set of locations relevant to this result.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
suppressions
A set of suppressions relevant to this result.
{"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}
sarif-2.1.0-rtm.6.json
baselineState
The state of a result relative to a baseline of a previous run.
{"enum": ["new", "unchanged", "updated", "absent"]}
sarif-2.1.0-rtm.6.json
rank
A number representing the priority or importance of the result.
{"type": "number", "default": -1.0, "minimum": -1.0, "maximum": 100.0}
sarif-2.1.0-rtm.6.json
attachments
A set of artifacts relevant to the result.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
hostedViewerUri
An absolute URI at which the result can be viewed.
{"type": "string", "format": "uri"}
sarif-2.1.0-rtm.6.json
workItemUris
The URIs of the work items associated with this result.
{"type": "array", "minItems": 0, "uniqueItems": true, "items": {"type": "string", "format": "uri"}}
sarif-2.1.0-rtm.6.json
provenance
Information about how and when the result was detected.
{}
sarif-2.1.0-rtm.6.json
fixes
An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
taxa
An array of references to taxonomy reporting descriptors that are applicable to the result.
{"type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": {}}
sarif-2.1.0-rtm.6.json
webRequest
A web request associated with this result.
{}
sarif-2.1.0-rtm.6.json
webResponse
A web response associated with this result.
{}
sarif-2.1.0-rtm.6.json
properties
Key/value pairs that provide additional information about the result.
{}
sarif-2.1.0-rtm.6.json
resultProvenance
Contains information about how and when a result was detected.
{"additionalProperties": false, "type": "object", "properties": {"firstDetectionTimeUtc": {"type": "string", "format": "date-time"}, "lastDetectionTimeUtc": {"type": "string", "format": "date-time"}, "firstDetectionRunGuid": {"type": "string", "format": "uuid"}, "lastDetectionRunGuid": {"type": "string", "format": "uuid"}, "invocationIndex": {"type": "integer", "default": -1, "minimum": -1}, "conversionSources": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}}
sarif-2.1.0-rtm.6.json
firstDetectionTimeUtc
The Coordinated Universal Time (UTC) date and time at which the result was first detected. See "Date/time properties" in the SARIF spec for the required format.
{"type": "string", "format": "date-time"}
sarif-2.1.0-rtm.6.json
lastDetectionTimeUtc
The Coordinated Universal Time (UTC) date and time at which the result was most recently detected. See "Date/time properties" in the SARIF spec for the required format.
{"type": "string", "format": "date-time"}
sarif-2.1.0-rtm.6.json
firstDetectionRunGuid
A GUID-valued string equal to the automationDetails.guid property of the run in which the result was first detected.
{"type": "string", "format": "uuid"}
sarif-2.1.0-rtm.6.json
lastDetectionRunGuid
A GUID-valued string equal to the automationDetails.guid property of the run in which the result was most recently detected.
{"type": "string", "format": "uuid"}
sarif-2.1.0-rtm.6.json
invocationIndex
The index within the run.invocations array of the invocation object which describes the tool invocation that detected the result.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0-rtm.6.json
conversionSources
An array of physicalLocation objects which specify the portions of an analysis tool's output that a converter transformed into the result.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
properties
Key/value pairs that provide additional information about the result.
{}
sarif-2.1.0-rtm.6.json
run
Describes a single run of an analysis tool, and contains the reported output of that run.
{"additionalProperties": false, "type": "object", "properties": {"tool": {}, "invocations": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "conversion": {}, "language": {"type": "string", "default": "en-US", "pattern": "^[a-zA-Z]{2}(-[a-zA-Z]{2})?$"}, "versionControlProvenance": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "originalUriBaseIds": {"type": "object", "additionalProperties": {}}, "artifacts": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}, "logicalLocations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "graphs": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "results": {"type": "array", "minItems": 0, "uniqueItems": false, "items": {}}, "automationDetails": {}, "runAggregates": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "baselineGuid": {"type": "string", "format": "uuid"}, "redactionTokens": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {"type": "string"}}, "defaultEncoding": {"type": "string"}, "defaultSourceLanguage": {"type": "string"}, "newlineSequences": {"type": "array", "minItems": 1, "uniqueItems": true, "default": ["\r\n", "\n"], "items": {"type": "string"}}, "columnKind": {"enum": ["utf16CodeUnits", "unicodeCodePoints"]}, "externalPropertyFileReferences": {}, "threadFlowLocations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "taxonomies": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "addresses": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "translations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "policies": {"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": {}}, "specialLocations": {}, "properties": {}}, "required": ["tool"]}
sarif-2.1.0-rtm.6.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-2.1.0-rtm.6.json
invocations
Describes the invocation of the analysis tool.
{"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
conversion
A conversion object that describes how a converter transformed an analysis tool's native reporting format into the SARIF format.
{}
sarif-2.1.0-rtm.6.json
language
The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase culture code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).
{"type": "string", "default": "en-US", "pattern": "^[a-zA-Z]{2}(-[a-zA-Z]{2})?$"}
sarif-2.1.0-rtm.6.json
versionControlProvenance
Specifies the revision in version control of the artifacts that were scanned.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
originalUriBaseIds
The artifact location specified by each uriBaseId symbol on the machine where the tool originally ran.
{"type": "object", "additionalProperties": {}}
sarif-2.1.0-rtm.6.json
artifacts
An array of artifact objects relevant to the run.
{"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}
sarif-2.1.0-rtm.6.json
logicalLocations
An array of logical locations such as namespaces, types or functions.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
graphs
An array of zero or more unique graph objects associated with the run.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.6.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) if a log file represents an actual scan.
{"type": "array", "minItems": 0, "uniqueItems": false, "items": {}}
sarif-2.1.0-rtm.6.json
automationDetails
Automation details that describe this run.
{}
sarif-2.1.0-rtm.6.json
runAggregates
Automation details that describe the aggregate of runs to which this run belongs.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
baselineGuid
The 'guid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.
{"type": "string", "format": "uuid"}
sarif-2.1.0-rtm.6.json
redactionTokens
An array of strings used to replace sensitive information in a redaction-aware property.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {"type": "string"}}
sarif-2.1.0-rtm.6.json
defaultEncoding
Specifies the default encoding for any artifact object that refers to a text file.
{"type": "string"}
sarif-2.1.0-rtm.6.json
defaultSourceLanguage
Specifies the default source language for any artifact object that refers to a text file that contains source code.
{"type": "string"}
sarif-2.1.0-rtm.6.json
newlineSequences
An ordered list of character sequences that were treated as line breaks when computing region information for the run.
{"type": "array", "minItems": 1, "uniqueItems": true, "default": ["\r\n", "\n"], "items": {"type": "string"}}
sarif-2.1.0-rtm.6.json
columnKind
Specifies the unit in which the tool measures columns.
{"enum": ["utf16CodeUnits", "unicodeCodePoints"]}
sarif-2.1.0-rtm.6.json
externalPropertyFileReferences
References to external property files that should be inlined with the content of a root log file.
{}
sarif-2.1.0-rtm.6.json
threadFlowLocations
An array of threadFlowLocation objects cached at run level.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
taxonomies
An array of toolComponent objects relevant to a taxonomy in which results are categorized.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
addresses
Addresses associated with this run instance, if any.
{"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
translations
The set of available translations of the localized data provided by the tool.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
policies
Contains configurations that may potentially override both reportingDescriptor.defaultConfiguration (the tool's default severities) and invocation.configurationOverrides (severities established at run-time from the command line).
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
webRequests
An array of request objects cached at run level.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
webResponses
An array of response objects cached at run level.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
specialLocations
A specialLocations object that defines locations of special significance to SARIF consumers.
{}
sarif-2.1.0-rtm.6.json
properties
Key/value pairs that provide additional information about the run.
{}
sarif-2.1.0-rtm.6.json
runAutomationDetails
Information that describes a run's identity and role within an engineering system process.
{"additionalProperties": false, "type": "object", "properties": {"id": {"type": "string"}, "guid": {"type": "string", "format": "uuid"}, "correlationGuid": {"type": "string", "format": "uuid"}, "properties": {}}}
sarif-2.1.0-rtm.6.json
description
A description of the identity and role played within the engineering system by this object's containing run object.
{}
sarif-2.1.0-rtm.6.json
id
A hierarchical string that uniquely identifies this object's containing run object.
{"type": "string"}
sarif-2.1.0-rtm.6.json
guid
A stable, unique identifier for this object's containing run object in the form of a GUID.
{"type": "string", "format": "uuid"}
sarif-2.1.0-rtm.6.json
correlationGuid
A stable, unique identifier for the equivalence class of runs to which this object's containing run object belongs in the form of a GUID.
{"type": "string", "format": "uuid"}
sarif-2.1.0-rtm.6.json
properties
Key/value pairs that provide additional information about the run automation details.
{}
sarif-2.1.0-rtm.6.json
specialLocations
Defines locations of special significance to SARIF consumers.
{"type": "object", "additionalProperties": false, "properties": {"displayBase": {}, "properties": {}}}
sarif-2.1.0-rtm.6.json
displayBase
Provides a suggestion to SARIF consumers to display file paths relative to the specified location.
{}
sarif-2.1.0-rtm.6.json
properties
Key/value pairs that provide additional information about the special locations.
{}
sarif-2.1.0-rtm.6.json
stack
A call stack that is relevant to a result.
{"additionalProperties": false, "type": "object", "properties": {"message": {}, "frames": {"type": "array", "minItems": 0, "uniqueItems": false, "items": {}}, "properties": {}}, "required": ["frames"]}
sarif-2.1.0-rtm.6.json
message
A message relevant to this call stack.
{}
sarif-2.1.0-rtm.6.json
frames
An array of stack frames that represents a sequence of calls, rendered in reverse chronological order, that comprise the call stack.
{"type": "array", "minItems": 0, "uniqueItems": false, "items": {}}
sarif-2.1.0-rtm.6.json
properties
Key/value pairs that provide additional information about the stack.
{}
sarif-2.1.0-rtm.6.json
stackFrame
A function call within a stack trace.
{"additionalProperties": false, "type": "object", "properties": {"location": {}, "module": {"type": "string"}, "threadId": {"type": "integer"}, "parameters": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {"type": "string", "default": []}}, "properties": {}}}
sarif-2.1.0-rtm.6.json
location
The location to which this stack frame refers.
{}
sarif-2.1.0-rtm.6.json
module
The name of the module that contains the code of this stack frame.
{"type": "string"}
sarif-2.1.0-rtm.6.json
threadId
The thread identifier of the stack frame.
{"type": "integer"}
sarif-2.1.0-rtm.6.json
parameters
The parameters of the call that is executing.
{"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {"type": "string", "default": []}}
sarif-2.1.0-rtm.6.json
properties
Key/value pairs that provide additional information about the stack frame.
{}
sarif-2.1.0-rtm.6.json
suppression
A suppression that is relevant to a result.
{"additionalProperties": false, "type": "object", "properties": {"guid": {"type": "string", "format": "uuid"}, "kind": {"enum": ["inSource", "external"]}, "status": {"enum": ["accepted", "underReview", "rejected"]}, "justification": {"type": "string"}, "location": {}, "properties": {}}, "required": ["kind"]}
sarif-2.1.0-rtm.6.json
guid
A stable, unique identifier for the suprression in the form of a GUID.
{"type": "string", "format": "uuid"}
sarif-2.1.0-rtm.6.json
kind
A string that indicates where the suppression is persisted.
{"enum": ["inSource", "external"]}
sarif-2.1.0-rtm.6.json
status
A string that indicates the review status of the suppression.
{"enum": ["accepted", "underReview", "rejected"]}
sarif-2.1.0-rtm.6.json
justification
A string representing the justification for the suppression.
{"type": "string"}
sarif-2.1.0-rtm.6.json
location
Identifies the location associated with the suppression.
{}
sarif-2.1.0-rtm.6.json
properties
Key/value pairs that provide additional information about the suppression.
{}
sarif-2.1.0-rtm.6.json
threadFlow
Describes a sequence of code locations that specify a path through a single thread of execution such as an operating system or fiber.
{"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "message": {}, "initialState": {"type": "object", "additionalProperties": {}}, "immutableState": {"type": "object", "additionalProperties": {}}, "locations": {"type": "array", "minItems": 1, "uniqueItems": false, "items": {}}, "properties": {}}, "required": ["locations"]}
sarif-2.1.0-rtm.6.json
id
An string that uniquely identifies the threadFlow within the codeFlow in which it occurs.
{"type": "string"}
sarif-2.1.0-rtm.6.json
message
A message relevant to the thread flow.
{}
sarif-2.1.0-rtm.6.json
initialState
Values of relevant expressions at the start of the thread flow that may change during thread flow execution.
{"type": "object", "additionalProperties": {}}
sarif-2.1.0-rtm.6.json
immutableState
Values of relevant expressions at the start of the thread flow that remain constant.
{"type": "object", "additionalProperties": {}}
sarif-2.1.0-rtm.6.json
locations
A temporally ordered array of 'threadFlowLocation' objects, each of which describes a location visited by the tool while producing the result.
{"type": "array", "minItems": 1, "uniqueItems": false, "items": {}}
sarif-2.1.0-rtm.6.json
properties
Key/value pairs that provide additional information about the thread flow.
{}
sarif-2.1.0-rtm.6.json
threadFlowLocation
A location visited by an analysis tool while simulating or monitoring the execution of a program.
{"additionalProperties": false, "type": "object", "properties": {"index": {"type": "integer", "default": -1, "minimum": -1}, "location": {}, "stack": {}, "kinds": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {"type": "string"}}, "taxa": {"type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": {}}, "module": {"type": "string"}, "state": {"type": "object", "additionalProperties": {}}, "nestingLevel": {"type": "integer", "minimum": 0}, "executionOrder": {"type": "integer", "default": -1, "minimum": -1}, "executionTimeUtc": {"type": "string", "format": "date-time"}, "importance": {"enum": ["important", "essential", "unimportant"], "default": "important"}, "webRequest": {}, "webResponse": {}, "properties": {}}}