schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
sarif-2.1.0-rtm.3.json
region
A region within an artifact where a result was detected.
{"additionalProperties": false, "type": "object", "properties": {"startLine": {"type": "integer", "minimum": 1}, "startColumn": {"type": "integer", "minimum": 1}, "endLine": {"type": "integer", "minimum": 1}, "endColumn": {"type": "integer", "minimum": 1}, "charOffset": {"type": "integer", "default": -1, "minimum": -1}, "charLength": {"type": "integer", "minimum": 0}, "byteOffset": {"type": "integer", "default": -1, "minimum": -1}, "byteLength": {"type": "integer", "minimum": 0}, "snippet": {}, "message": {}, "sourceLanguage": {"type": "string"}, "properties": {}}}
sarif-2.1.0-rtm.3.json
startLine
The line number of the first character in the region.
{"type": "integer", "minimum": 1}
sarif-2.1.0-rtm.3.json
startColumn
The column number of the first character in the region.
{"type": "integer", "minimum": 1}
sarif-2.1.0-rtm.3.json
endLine
The line number of the last character in the region.
{"type": "integer", "minimum": 1}
sarif-2.1.0-rtm.3.json
endColumn
The column number of the character following the end of the region.
{"type": "integer", "minimum": 1}
sarif-2.1.0-rtm.3.json
charOffset
The zero-based offset from the beginning of the artifact of the first character in the region.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0-rtm.3.json
charLength
The length of the region in characters.
{"type": "integer", "minimum": 0}
sarif-2.1.0-rtm.3.json
byteOffset
The zero-based offset from the beginning of the artifact of the first byte in the region.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0-rtm.3.json
byteLength
The length of the region in bytes.
{"type": "integer", "minimum": 0}
sarif-2.1.0-rtm.3.json
snippet
The portion of the artifact contents within the specified region.
{}
sarif-2.1.0-rtm.3.json
message
A message relevant to the region.
{}
sarif-2.1.0-rtm.3.json
sourceLanguage
Specifies the source language, if any, of the portion of the artifact specified by the region object.
{"type": "string"}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the region.
{}
sarif-2.1.0-rtm.3.json
replacement
The replacement of a single region of an artifact.
{"additionalProperties": false, "type": "object", "properties": {"deletedRegion": {}, "insertedContent": {}, "properties": {}}, "required": ["deletedRegion"]}
sarif-2.1.0-rtm.3.json
deletedRegion
The region of the artifact to delete.
{}
sarif-2.1.0-rtm.3.json
insertedContent
The content to insert at the location specified by the 'deletedRegion' property.
{}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the replacement.
{}
sarif-2.1.0-rtm.3.json
reportingDescriptor
Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.
{"additionalProperties": false, "type": "object", "properties": {"id": {"type": "string"}, "deprecatedIds": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {"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}$"}, "deprecatedGuids": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {"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"}, "deprecatedNames": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {"type": "string"}}, "shortDescription": {}, "fullDescription": {}, "messageStrings": {"type": "object", "additionalProperties": {}}, "defaultConfiguration": {}, "helpUri": {"type": "string", "format": "uri"}, "help": {}, "relationships": {"type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": {}}, "properties": {}}, "required": ["id"]}
sarif-2.1.0-rtm.3.json
id
A stable, opaque identifier for the report.
{"type": "string"}
sarif-2.1.0-rtm.3.json
deprecatedIds
An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool.
{"type": "array", "minItems": 0, "uniqueItems": true, "items": {"type": "string"}}
sarif-2.1.0-rtm.3.json
guid
A unique identifier for the reporting descriptor 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
deprecatedGuids
An array of unique identifies in the form of a GUID by which this report was known in some previous version of the analysis tool.
{"type": "array", "minItems": 0, "uniqueItems": true, "items": {"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
A report identifier that is understandable to an end user.
{"type": "string"}
sarif-2.1.0-rtm.3.json
deprecatedNames
An array of readable identifiers by which this report was known in some previous version of the analysis tool.
{"type": "array", "minItems": 0, "uniqueItems": true, "items": {"type": "string"}}
sarif-2.1.0-rtm.3.json
shortDescription
A concise description of the report. Should be a single sentence that is understandable when visible space is limited to a single line of text.
{}
sarif-2.1.0-rtm.3.json
fullDescription
A description of the report. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.
{}
sarif-2.1.0-rtm.3.json
messageStrings
A set of name/value pairs with arbitrary names. Each value 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
defaultConfiguration
Default reporting configuration information.
{}
sarif-2.1.0-rtm.3.json
helpUri
A URI where the primary documentation for the report can be found.
{"type": "string", "format": "uri"}
sarif-2.1.0-rtm.3.json
help
Provides the primary documentation for the report, useful when there is no online documentation.
{}
sarif-2.1.0-rtm.3.json
relationships
An array of objects that describe relationships between this reporting descriptor 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 report.
{}
sarif-2.1.0-rtm.3.json
reportingConfiguration
Information about a rule or notification that can be configured at runtime.
{"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean", "default": true}, "level": {"default": "warning", "enum": ["none", "note", "warning", "error"]}, "rank": {"type": "number", "default": -1, "minimum": -1, "maximum": 100}, "parameters": {}, "properties": {}}}
sarif-2.1.0-rtm.3.json
enabled
Specifies whether the report may be produced during the scan.
{"type": "boolean", "default": true}
sarif-2.1.0-rtm.3.json
level
Specifies the failure level for the report.
{"default": "warning", "enum": ["none", "note", "warning", "error"]}
sarif-2.1.0-rtm.3.json
rank
Specifies the relative priority of the report. Used for analysis output only.
{"type": "number", "default": -1, "minimum": -1, "maximum": 100}
sarif-2.1.0-rtm.3.json
parameters
Contains configuration information specific to a report.
{}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the reporting configuration.
{}
sarif-2.1.0-rtm.3.json
reportingDescriptorReference
Information about how to locate a relevant reporting descriptor.
{"type": "object", "additionalProperties": false, "properties": {"id": {"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}$"}, "toolComponent": {}, "properties": {}}, "anyOf": [{"required": ["index"]}, {"required": ["guid"]}, {"required": ["id"]}]}
sarif-2.1.0-rtm.3.json
id
The id of the descriptor.
{"type": "string"}
sarif-2.1.0-rtm.3.json
index
The index into an array of descriptors in toolComponent.ruleDescriptors, toolComponent.notificationDescriptors, or toolComponent.taxonomyDescriptors, depending on context.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0-rtm.3.json
guid
A guid that uniquely identifies the descriptor.
{"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
toolComponent
A reference used to locate the toolComponent associated with the descriptor.
{}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the reporting descriptor reference.
{}
sarif-2.1.0-rtm.3.json
reportingDescriptorRelationship
Information about the relation of one reporting descriptor to another.
{"type": "object", "additionalProperties": false, "properties": {"target": {}, "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 reporting descriptor.
{}
sarif-2.1.0-rtm.3.json
kinds
A set of distinct strings that categorize the relationship. Well-known kinds include 'canPrecede', 'canFollow', 'willPrecede', 'willFollow', 'superset', 'subset', 'equal', 'disjoint', 'relevant', and 'incomparable'.
{"type": "array", "default": ["relevant"], "uniqueItems": true, "items": {"type": "string"}}
sarif-2.1.0-rtm.3.json
description
A description of the reporting descriptor relationship.
{}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the reporting descriptor reference.
{}
sarif-2.1.0-rtm.3.json
result
A result produced by an analysis tool.
{"additionalProperties": false, "type": "object", "properties": {"ruleId": {"type": "string"}, "ruleIndex": {"type": "integer", "default": -1, "minimum": -1}, "rule": {}, "kind": {"default": "fail", "enum": ["notApplicable", "pass", "fail", "review", "open", "informational"]}, "level": {"default": "warning", "enum": ["none", "note", "warning", "error"]}, "message": {}, "analysisTarget": {}, "locations": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "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}$"}, "occurrenceCount": {"type": "integer", "minimum": 1}, "partialFingerprints": {"type": "object", "additionalProperties": {"type": "string"}}, "fingerprints": {"type": "object", "additionalProperties": {"type": "string"}}, "stacks": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "codeFlows": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "graphs": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "graphTraversals": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "relatedLocations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "suppressions": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}, "baselineState": {"enum": ["new", "unchanged", "updated", "absent"]}, "rank": {"type": "number", "default": -1, "minimum": -1, "maximum": 100}, "attachments": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "hostedViewerUri": {"type": "string", "format": "uri"}, "workItemUris": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {"type": "string", "format": "uri"}}, "provenance": {}, "fixes": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "taxa": {"type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": {}}, "webRequest": {}, "webResponse": {}, "properties": {}}, "required": ["message"]}
sarif-2.1.0-rtm.3.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.1.0-rtm.3.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.3.json
rule
A reference used to locate the rule descriptor relevant to this result.
{}
sarif-2.1.0-rtm.3.json
kind
A value that categorizes results by evaluation state.
{"default": "fail", "enum": ["notApplicable", "pass", "fail", "review", "open", "informational"]}
sarif-2.1.0-rtm.3.json
level
A value specifying the severity level of the result.
{"default": "warning", "enum": ["none", "note", "warning", "error"]}
sarif-2.1.0-rtm.3.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.3.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.3.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.3.json
guid
A stable, unique identifier for the result 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 logically identical results to which this result 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
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.3.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.3.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.3.json
stacks
An array of 'stack' objects relevant to the result.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
codeFlows
An array of 'codeFlow' objects relevant to the result.
{"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}
sarif-2.1.0-rtm.3.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.3.json
graphTraversals
An array of one or more unique 'graphTraversal' objects.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
relatedLocations
A set of locations relevant to this result.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
suppressions
A set of suppressions relevant to this result.
{"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}
sarif-2.1.0-rtm.3.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.3.json
rank
A number representing the priority or importance of the result.
{"type": "number", "default": -1, "minimum": -1, "maximum": 100}
sarif-2.1.0-rtm.3.json
attachments
A set of artifacts relevant to the result.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
hostedViewerUri
An absolute URI at which the result can be viewed.
{"type": "string", "format": "uri"}
sarif-2.1.0-rtm.3.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.3.json
provenance
Information about how and when the result was detected.
{}
sarif-2.1.0-rtm.3.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.3.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.3.json
webRequest
A web request associated with this result.
{}
sarif-2.1.0-rtm.3.json
webResponse
A web response associated with this result.
{}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the result.
{}
sarif-2.1.0-rtm.3.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", "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}$"}, "lastDetectionRunGuid": {"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}$"}, "invocationIndex": {"type": "integer", "default": -1, "minimum": -1}, "conversionSources": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}}
sarif-2.1.0-rtm.3.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.3.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.3.json
firstDetectionRunGuid
A GUID-valued string equal to the automationDetails.guid property of the run in which the result was first detected.
{"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
lastDetectionRunGuid
A GUID-valued string equal to the automationDetails.guid property of the run in which the result was most recently detected.
{"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
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.3.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.3.json
properties
Key/value pairs that provide additional information about the result.
{}
sarif-2.1.0-rtm.3.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}-[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", "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}$"}, "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.3.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.3.json
invocations
Describes the invocation of the analysis tool.
{"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}
sarif-2.1.0-rtm.3.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.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 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}-[a-zA-Z]{2}?$"}
sarif-2.1.0-rtm.3.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.3.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.3.json
artifacts
An array of artifact objects relevant to the run.
{"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}
sarif-2.1.0-rtm.3.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.3.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.3.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.3.json
automationDetails
Automation details that describe this run.
{}