schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
sarif-2.1.0-rtm.3.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.3.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", "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-rtm.3.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.3.json
defaultEncoding
Specifies the default encoding for any artifact object that refers to a text file.
{"type": "string"}
sarif-2.1.0-rtm.3.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.3.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.3.json
columnKind
Specifies the unit in which the tool measures columns.
{"enum": ["utf16CodeUnits", "unicodeCodePoints"]}
sarif-2.1.0-rtm.3.json
externalPropertyFileReferences
References to external property files that should be inlined with the content of a root log file.
{}
sarif-2.1.0-rtm.3.json
threadFlowLocations
An array of threadFlowLocation objects cached at run level.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.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.3.json
addresses
Addresses associated with this run instance, if any.
{"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}
sarif-2.1.0-rtm.3.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.3.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.3.json
webRequests
An array of request objects cached at run level.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
webResponses
An array of response objects cached at run level.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
specialLocations
A specialLocations object that defines locations of special significance to SARIF consumers.
{}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the run.
{}
sarif-2.1.0-rtm.3.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", "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}$"}, "correlationGuid": {"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}$"}, "properties": {}}}
sarif-2.1.0-rtm.3.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.3.json
id
A hierarchical string that uniquely identifies this object's containing run object.
{"type": "string"}
sarif-2.1.0-rtm.3.json
guid
A stable, unique identifier for this object's containing run object 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-rtm.3.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", "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-rtm.3.json
properties
Key/value pairs that provide additional information about the run automation details.
{}
sarif-2.1.0-rtm.3.json
specialLocations
Defines locations of special significance to SARIF consumers.
{"type": "object", "properties": {"displayBase": {}, "properties": {}}}
sarif-2.1.0-rtm.3.json
displayBase
Provides a suggestion to SARIF consumers to display file paths relative to the specified location.
{}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the special locations.
{}
sarif-2.1.0-rtm.3.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.3.json
message
A message relevant to this call stack.
{}
sarif-2.1.0-rtm.3.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.3.json
properties
Key/value pairs that provide additional information about the stack.
{}
sarif-2.1.0-rtm.3.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.3.json
location
The location to which this stack frame refers.
{}
sarif-2.1.0-rtm.3.json
module
The name of the module that contains the code of this stack frame.
{"type": "string"}
sarif-2.1.0-rtm.3.json
threadId
The thread identifier of the stack frame.
{"type": "integer"}
sarif-2.1.0-rtm.3.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.3.json
properties
Key/value pairs that provide additional information about the stack frame.
{}
sarif-2.1.0-rtm.3.json
suppression
A suppression that is relevant to a result.
{"additionalProperties": false, "type": "object", "properties": {"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}$"}, "kind": {"enum": ["inSource", "external"]}, "state": {"enum": ["accepted", "underReview", "rejected"]}, "justification": {"type": "string"}, "location": {}, "properties": {}}, "required": ["kind"]}
sarif-2.1.0-rtm.3.json
guid
A stable, unique identifier for the suppression 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-rtm.3.json
kind
A string that indicates where the suppression is persisted.
{"enum": ["inSource", "external"]}
sarif-2.1.0-rtm.3.json
state
A string that indicates the state of the suppression.
{"enum": ["accepted", "underReview", "rejected"]}
sarif-2.1.0-rtm.3.json
justification
A string representing the justification for the suppression.
{"type": "string"}
sarif-2.1.0-rtm.3.json
location
Identifies the location associated with the suppression.
{}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the suppression.
{}
sarif-2.1.0-rtm.3.json
id
An string that uniquely identifies the threadFlow within the codeFlow in which it occurs.
{"type": "string"}
sarif-2.1.0-rtm.3.json
message
A message relevant to the thread flow.
{}
sarif-2.1.0-rtm.3.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.3.json
immutableState
Values of relevant expressions at the start of the thread flow that remain constant.
{"type": "object", "additionalProperties": {}}
sarif-2.1.0-rtm.3.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.3.json
properties
Key/value pairs that provide additional information about the thread flow.
{}
sarif-2.1.0-rtm.3.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": {}}}
sarif-2.1.0-rtm.3.json
index
The index within the run threadFlowLocations array.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0-rtm.3.json
location
The code location.
{}
sarif-2.1.0-rtm.3.json
stack
The call stack leading to this location.
{}
sarif-2.1.0-rtm.3.json
kinds
A set of distinct strings that categorize the thread flow location. Well-known kinds include 'acquire', 'release', 'enter', 'exit', 'call', 'return', 'branch', 'implicit', 'false', 'true', 'caution', 'danger', 'unknown', 'unreachable', 'taint', 'function', 'handler', 'lock', 'memory', 'resource', 'scope' and 'value'.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {"type": "string"}}
sarif-2.1.0-rtm.3.json
taxa
An array of references to rule or taxonomy reporting descriptors that are applicable to the thread flow location.
{"type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": {}}
sarif-2.1.0-rtm.3.json
module
The name of the module that contains the code that is executing.
{"type": "string"}
sarif-2.1.0-rtm.3.json
state
A dictionary, each of whose keys specifies a variable or expression, the associated value of which represents the variable or expression value. For an annotation of kind 'continuation', for example, this dictionary might hold the current assumed values of a set of global variables.
{"type": "object", "additionalProperties": {}}
sarif-2.1.0-rtm.3.json
nestingLevel
An integer representing a containment hierarchy within the thread flow.
{"type": "integer", "minimum": 0}
sarif-2.1.0-rtm.3.json
executionOrder
An integer representing the temporal order in which execution reached this location.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0-rtm.3.json
executionTimeUtc
The Coordinated Universal Time (UTC) date and time at which this location was executed.
{"type": "string", "format": "date-time"}
sarif-2.1.0-rtm.3.json
importance
Specifies the importance of this location in understanding the code flow in which it occurs. The order from most to least important is "essential", "important", "unimportant". Default: "important".
{"enum": ["important", "essential", "unimportant"], "default": "important"}
sarif-2.1.0-rtm.3.json
webRequest
A web request associated with this thread flow location.
{}
sarif-2.1.0-rtm.3.json
webResponse
A web response associated with this thread flow location.
{}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the threadflow location.
{}
sarif-2.1.0-rtm.3.json
tool
The analysis tool that was run.
{"additionalProperties": false, "type": "object", "properties": {"driver": {}, "extensions": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}, "required": ["driver"]}
sarif-2.1.0-rtm.3.json
driver
The analysis tool that was run.
{}
sarif-2.1.0-rtm.3.json
extensions
Tool extensions that contributed to or reconfigured the analysis tool that was run.
{"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 tool.
{}
sarif-2.1.0-rtm.3.json
toolComponent
A component, such as a plug-in or the driver, of the analysis tool that was run.
{"additionalProperties": false, "type": "object", "properties": {"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}$"}, "name": {"type": "string"}, "organization": {"type": "string"}, "product": {"type": "string"}, "productSuite": {"type": "string"}, "shortDescription": {}, "fullDescription": {}, "fullName": {"type": "string"}, "version": {"type": "string"}, "semanticVersion": {"type": "string"}, "dottedQuadFileVersion": {"type": "string", "pattern": "[0-9]+(\\.[0-9]+){3}"}, "releaseDateUtc": {"type": "string"}, "downloadUri": {"type": "string", "format": "uri"}, "informationUri": {"type": "string", "format": "uri"}, "globalMessageStrings": {"type": "object", "additionalProperties": {}}, "notifications": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "rules": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "taxa": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "locations": {"type": "array", "minItems": 0, "default": [], "items": {}}, "language": {"type": "string", "default": "en-US", "pattern": "^[a-zA-Z]{2}|^[a-zA-Z]{2}-[a-zA-Z]{2}?$"}, "contents": {"type": "array", "uniqueItems": true, "default": ["localizedData", "nonLocalizedData"], "items": {"enum": ["localizedData", "nonLocalizedData"]}}, "isComprehensive": {"type": "boolean", "default": false}, "localizedDataSemanticVersion": {"type": "string"}, "minimumRequiredLocalizedDataSemanticVersion": {"type": "string"}, "associatedComponent": {}, "translationMetadata": {}, "supportedTaxonomies": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}, "required": ["name"]}
sarif-2.1.0-rtm.3.json
guid
A unique identifier for the tool component 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-rtm.3.json
name
The name of the tool component.
{"type": "string"}
sarif-2.1.0-rtm.3.json
organization
The organization or company that produced the tool component.
{"type": "string"}
sarif-2.1.0-rtm.3.json
product
A product suite to which the tool component belongs.
{"type": "string"}
sarif-2.1.0-rtm.3.json
productSuite
A localizable string containing the name of the suite of products to which the tool component belongs.
{"type": "string"}
sarif-2.1.0-rtm.3.json
shortDescription
A brief description of the tool component.
{}
sarif-2.1.0-rtm.3.json
fullDescription
A comprehensive description of the tool component.
{}
sarif-2.1.0-rtm.3.json
fullName
The name of the tool component along with its version and any other useful identifying information, such as its locale.
{"type": "string"}
sarif-2.1.0-rtm.3.json
version
The tool component version, in whatever format the component natively provides.
{"type": "string"}
sarif-2.1.0-rtm.3.json
semanticVersion
The tool component version in the format specified by Semantic Versioning 2.0.
{"type": "string"}
sarif-2.1.0-rtm.3.json
dottedQuadFileVersion
The binary version of the tool component's primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).
{"type": "string", "pattern": "[0-9]+(\\.[0-9]+){3}"}
sarif-2.1.0-rtm.3.json
releaseDateUtc
A string specifying the UTC date (and optionally, the time) of the component's release.
{"type": "string"}
sarif-2.1.0-rtm.3.json
downloadUri
The absolute URI from which the tool component can be downloaded.
{"type": "string", "format": "uri"}
sarif-2.1.0-rtm.3.json
informationUri
The absolute URI at which information about this version of the tool component can be found.
{"type": "string", "format": "uri"}
sarif-2.1.0-rtm.3.json
globalMessageStrings
A dictionary, each of whose keys is a resource identifier and each of whose values is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.
{"type": "object", "additionalProperties": {}}
sarif-2.1.0-rtm.3.json
notifications
An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
rules
An array of reportingDescriptor objects relevant to the analysis performed by the tool component.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
taxa
An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
locations
An array of the artifactLocation objects associated with the tool component.
{"type": "array", "minItems": 0, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
language
The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language 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}-[a-zA-Z]{2}?$"}
sarif-2.1.0-rtm.3.json
contents
The kinds of data contained in this object.
{"type": "array", "uniqueItems": true, "default": ["localizedData", "nonLocalizedData"], "items": {"enum": ["localizedData", "nonLocalizedData"]}}
sarif-2.1.0-rtm.3.json
isComprehensive
Specifies whether this object contains a complete definition of the localizable and/or non-localizable data for this component, as opposed to including only data that is relevant to the results persisted to this log file.
{"type": "boolean", "default": false}
sarif-2.1.0-rtm.3.json
localizedDataSemanticVersion
The semantic version of the localized strings defined in this component; maintained by components that provide translations.
{"type": "string"}
sarif-2.1.0-rtm.3.json
minimumRequiredLocalizedDataSemanticVersion
The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.
{"type": "string"}
sarif-2.1.0-rtm.3.json
associatedComponent
The component which is strongly associated with this component. For a translation, this refers to the component which has been translated. For an extension, this is the driver that provides the extension's plugin model.
{}
sarif-2.1.0-rtm.3.json
translationMetadata
Translation metadata, required for a translation, not populated by other component types.
{}
sarif-2.1.0-rtm.3.json
supportedTaxonomies
An array of toolComponentReference objects to declare the taxonomies supported by the tool component.
{"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 tool component.
{}
sarif-2.1.0-rtm.3.json
toolComponentReference
{"type": "object", "properties": {"name": {"type": "string"}, "index": {"type": "integer", "default": -1, "minimum": -1}, "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}$"}, "properties": {}}}
sarif-2.1.0-rtm.3.json
name
The 'name' property of the referenced toolComponent.
{"type": "string"}
sarif-2.1.0-rtm.3.json
index
An index into the referenced toolComponent in tool.extensions.
{"type": "integer", "default": -1, "minimum": -1}