Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/sarif-2-0-0-json/latest.json
Source https://www.schemastore.org/sarif-2.0.0.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Static Analysis Results Format (SARIF) Version 2.0.0 JSON Schema: a standard format for the output of static analysis tools.

Properties

version enum required

The SARIF format version of this log file.

Values: "2.0.0"
runs run[] required

The set of runs contained in this log file.

minItems=1
$schema string

The URI of the JSON schema corresponding to the version.

format=uri

Definitions

attachment object

A file relevant to a tool invocation or to a result.

fileLocation object required

Specifies the location of a file.

2 nested properties
uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

description object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

regions region[]

An array of regions of interest within the attachment.

minItems=1uniqueItems=true
rectangles rectangle[]

An array of rectangles specifying areas of interest within the image.

minItems=1uniqueItems=true
codeFlow object

A set of threadFlows which together describe a pattern of code execution relevant to detecting a result.

threadFlows threadFlow[] required

An array of one or more unique threadFlow objects, each of which describes the progress of a program through a thread of execution.

minItems=1uniqueItems=true
message object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

properties object

Key/value pairs that provide additional information about the code flow.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
conversion object

Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.

tool object required

The analysis tool that was run.

9 nested properties
name string required

The name of the tool.

fullName string

The name of the tool along with its version and any other useful identifying information, such as its locale.

version string

The tool version, in whatever format the tool natively provides.

semanticVersion string

The tool version in the format specified by Semantic Versioning 2.0.

fileVersion string

The binary version of the tool's primary executable file (for operating systems such as Windows that provide that information).

pattern=[0-9]+(\.[0-9]+){3}
downloadUri string

The absolute URI from which the tool can be downloaded.

format=uri
sarifLoggerVersion string

A version that uniquely identifies the SARIF logging component that generated this file, if it is versioned separately from the tool.

language string

The tool language (expressed as an ISO 649 two-letter lowercase culture code) and region (expressed as an ISO 3166 two-letter uppercase subculture code associated with a country or region).

Default: "en-US"
properties object

Key/value pairs that provide additional information about the tool.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
invocation object

The runtime environment of the analysis tool run.

25 nested properties
commandLine string

The command line used to invoke the tool.

arguments string[]

An array of strings, containing in order the command line arguments passed to the tool from the operating system.

responseFiles fileLocation[]

The locations of any response files specified on the tool's command line.

attachments attachment[]

A set of files relevant to the invocation of the tool.

minItems=1uniqueItems=true
startTime string

The date and time at which the run started. See "Date/time properties" in the SARIF spec for the required format.

format=date-time
endTime string

The date and time at which the run ended. See "Date/time properties" in the SARIF spec for the required format.

format=date-time
exitCode integer

The process exit code.

toolNotifications notification[]

A list of runtime conditions detected by the tool during the analysis.

configurationNotifications notification[]

A list of conditions detected by the tool that are relevant to the tool's configuration.

exitCodeDescription string

The reason for the process exit.

exitSignalName string

The name of the signal that caused the process to exit.

exitSignalNumber integer

The numeric value of the signal that caused the process to exit.

processStartFailureMessage string

The reason given by the operating system that the process failed to start.

toolExecutionSuccessful boolean

A value indicating whether the tool's execution completed successfully.

machine string

The machine that hosted the analysis tool run.

account string

The account that ran the analysis tool.

processId integer

The process id for the analysis tool run.

executableLocation object

Specifies the location of a file.

2 nested properties
uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

workingDirectory object

Specifies the location of a file.

2 nested properties
uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

environmentVariables object

The environment variables associated with the analysis tool process, expressed as key/value pairs.

Default:
{}
stdin object

Specifies the location of a file.

2 nested properties
uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

stdout object

Specifies the location of a file.

2 nested properties
uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

stderr object

Specifies the location of a file.

2 nested properties
uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

stdoutStderr object

Specifies the location of a file.

2 nested properties
uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

properties object

Key/value pairs that provide additional information about the invocation.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
analysisToolLogFiles fileLocation[]

The locations of the analysis tool's per-run log files.

minItems=1uniqueItems=true
edge object

Represents a directed edge in a graph.

id string required

A string that uniquely identifies the edge within its graph.

sourceNodeId string required

Identifies the source node (the node at which the edge starts).

targetNodeId string required

Identifies the target node (the node at which the edge ends).

label object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

properties object

Key/value pairs that provide additional information about the edge.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
edgeTraversal object

Represents the traversal of a single edge during a graph traversal.

edgeId string required

Identifies the edge being traversed.

message object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

finalState Record<string, string>

The values of relevant expressions after the edge has been traversed.

stepOverEdgeCount integer

The number of edge traversals necessary to return from a nested graph.

properties object

Key/value pairs that provide additional information about the edge traversal.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
exception object
kind string

A string that identifies the kind of exception, for example, the fully qualified type name of an object that was thrown, or the symbolic name of a signal.

message string

A plain text message that describes the exception.

stack object

A call stack that is relevant to a result.

3 nested properties
frames stackFrame[] required

An array of stack frames that represent a sequence of calls, rendered in reverse chronological order, that comprise the call stack.

minItems=1
message object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

properties object

Key/value pairs that provide additional information about the stack.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
innerExceptions exception[]

An array of exception objects each of which is considered a cause of this exception.

externalFiles object

References to external files that should be inlined with the content of a root log file.

conversion object

Specifies the location of a file.

2 nested properties
uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

files object

Specifies the location of a file.

2 nested properties
uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

graphs object

Specifies the location of a file.

2 nested properties
uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

invocations fileLocation[]

An array of locations of files containing arrays of run.invocation objects to be merged with the root log file.

minItems=1uniqueItems=true
logicalLocations object

Specifies the location of a file.

2 nested properties
uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

resources object

Specifies the location of a file.

2 nested properties
uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

results fileLocation[]

An array of locations of files containing arrays of run.result objects to be merged with the root log file.

minItems=1uniqueItems=true
file object

A single file. In some cases, this file might be nested within another file.

fileLocation object

Specifies the location of a file.

2 nested properties
uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

parentKey string

Identifies the key of the immediate parent of the file, if this file is nested.

offset integer

The offset in bytes of the file within its containing file.

length integer

The length of the file in bytes.

roles enum[]

The role or roles played by the file in the analysis.

minItems=1uniqueItems=true
mimeType string

The MIME type (RFC 2045) of the file.

pattern=[^/]+/.+
contents object

Represents content from an external file.

2 nested properties
text string

UTF-8-encoded content from a text file.

binary string

MIME Base64-encoded content from a binary file, or from a text file in its original encoding.

encoding string

Specifies the encoding for a file object that refers to a text file.

hashes hash[]

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.

minItems=1uniqueItems=true
lastModifiedTime string

The date and time at which the file was most recently modified. See "Date/time properties" in the SARIF spec for the required format.

format=date-time
properties object

Key/value pairs that provide additional information about the file.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
fileChange object

A change to a single file.

fileLocation object required

Specifies the location of a file.

2 nested properties
uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

replacements replacement[] required

An array of replacement objects, each of which represents the replacement of a single region in a single file specified by 'fileLocation'.

minItems=1
fileContent object

Represents content from an external file.

text string

UTF-8-encoded content from a text file.

binary string

MIME Base64-encoded content from a binary file, or from a text file in its original encoding.

fileLocation object

Specifies the location of a file.

uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

fix object

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.

fileChanges fileChange[] required

One or more file changes that comprise a fix for a result.

description object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

graph object

A network of nodes and directed edges that describes some aspect of the structure of the code (for example, a call graph).

id string required

A string that uniquely identifies the graph within a run.graphs or result.graphs array.

nodes node[] required

An array of node objects representing the nodes of the graph.

edges edge[] required

An array of edge objects representing the edges of the graph.

description object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

properties object

Key/value pairs that provide additional information about the graph.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
graphTraversal object

Represents a path through a graph.

graphId string required

A string that uniquely identifies that graph being traversed.

edgeTraversals edgeTraversal[] required

The sequences of edges traversed by this graph traversal.

description object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

initialState Record<string, string>

Values of relevant expressions at the start of the graph traversal.

properties object

Key/value pairs that provide additional information about the graph traversal.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
hash object

A hash value of some file or collection of files, together with the hash function used to compute the hash.

value string required

The hash value of some file or collection of files, computed by the hash function named in the 'algorithm' property.

algorithm string required

The name of the hash function used to compute the hash value specified in the 'value' property.

invocation object

The runtime environment of the analysis tool run.

commandLine string

The command line used to invoke the tool.

arguments string[]

An array of strings, containing in order the command line arguments passed to the tool from the operating system.

responseFiles fileLocation[]

The locations of any response files specified on the tool's command line.

attachments attachment[]

A set of files relevant to the invocation of the tool.

minItems=1uniqueItems=true
startTime string

The date and time at which the run started. See "Date/time properties" in the SARIF spec for the required format.

format=date-time
endTime string

The date and time at which the run ended. See "Date/time properties" in the SARIF spec for the required format.

format=date-time
exitCode integer

The process exit code.

toolNotifications notification[]

A list of runtime conditions detected by the tool during the analysis.

configurationNotifications notification[]

A list of conditions detected by the tool that are relevant to the tool's configuration.

exitCodeDescription string

The reason for the process exit.

exitSignalName string

The name of the signal that caused the process to exit.

exitSignalNumber integer

The numeric value of the signal that caused the process to exit.

processStartFailureMessage string

The reason given by the operating system that the process failed to start.

toolExecutionSuccessful boolean

A value indicating whether the tool's execution completed successfully.

machine string

The machine that hosted the analysis tool run.

account string

The account that ran the analysis tool.

processId integer

The process id for the analysis tool run.

executableLocation object

Specifies the location of a file.

2 nested properties
uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

workingDirectory object

Specifies the location of a file.

2 nested properties
uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

environmentVariables object

The environment variables associated with the analysis tool process, expressed as key/value pairs.

Default:
{}
stdin object

Specifies the location of a file.

2 nested properties
uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

stdout object

Specifies the location of a file.

2 nested properties
uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

stderr object

Specifies the location of a file.

2 nested properties
uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

stdoutStderr object

Specifies the location of a file.

2 nested properties
uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

properties object

Key/value pairs that provide additional information about the invocation.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
location object

A location within a programming artifact.

physicalLocation object

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.

4 nested properties
fileLocation object required

Specifies the location of a file.

2 nested properties
uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

id integer

Value that distinguishes this physical location from all other physical locations in this run object.

region object

A region within a file where a result was detected.

10 nested properties
startLine integer

The line number of the first character in the region.

min=1
startColumn integer

The column number of the first character in the region.

min=1
endLine integer

The line number of the last character in the region.

min=1
endColumn integer

The column number of the character following the end of the region.

min=1
charOffset integer

The zero-based offset from the beginning of the file of the first character in the region.

min=0
charLength integer

The length of the region in characters.

min=0
byteOffset integer

The zero-based offset from the beginning of the file of the first byte in the region.

min=0
byteLength integer

The length of the region in bytes.

min=0
snippet object

Represents content from an external file.

message object

Encapsulates a message intended to be read by the end user.

contextRegion object

A region within a file where a result was detected.

10 nested properties
startLine integer

The line number of the first character in the region.

min=1
startColumn integer

The column number of the first character in the region.

min=1
endLine integer

The line number of the last character in the region.

min=1
endColumn integer

The column number of the character following the end of the region.

min=1
charOffset integer

The zero-based offset from the beginning of the file of the first character in the region.

min=0
charLength integer

The length of the region in characters.

min=0
byteOffset integer

The zero-based offset from the beginning of the file of the first byte in the region.

min=0
byteLength integer

The length of the region in bytes.

min=0
snippet object

Represents content from an external file.

message object

Encapsulates a message intended to be read by the end user.

fullyQualifiedLogicalName string

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.

message object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

annotations region[]

A set of regions relevant to the location.

minItems=1uniqueItems=true
properties object

Key/value pairs that provide additional information about the location.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
logicalLocation object

A logical location of a construct that produced a result.

name string

Identifies the construct in which the result occurred. For example, this property might contain the name of a class or a method.

fullyQualifiedName string

The human-readable fully qualified name of the logical location.

decoratedName string

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.

parentKey string

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.

kind string

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.

message object

Encapsulates a message intended to be read by the end user.

text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

node object

Represents a node in a graph.

id string required

A string that uniquely identifies the node within its graph.

label object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

location object

A location within a programming artifact.

5 nested properties
physicalLocation object

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.

4 nested properties
fileLocation object required

Specifies the location of a file.

id integer

Value that distinguishes this physical location from all other physical locations in this run object.

region object

A region within a file where a result was detected.

contextRegion object

A region within a file where a result was detected.

fullyQualifiedLogicalName string

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.

message object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

annotations region[]

A set of regions relevant to the location.

minItems=1uniqueItems=true
properties object

Key/value pairs that provide additional information about the location.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
children node[]

Array of child nodes.

uniqueItems=true
properties object

Key/value pairs that provide additional information about the node.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
notification object

Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.

message object required

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

id string

An identifier for the condition that was encountered.

ruleId string

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.

physicalLocation object

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.

4 nested properties
fileLocation object required

Specifies the location of a file.

2 nested properties
uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

id integer

Value that distinguishes this physical location from all other physical locations in this run object.

region object

A region within a file where a result was detected.

10 nested properties
startLine integer

The line number of the first character in the region.

min=1
startColumn integer

The column number of the first character in the region.

min=1
endLine integer

The line number of the last character in the region.

min=1
endColumn integer

The column number of the character following the end of the region.

min=1
charOffset integer

The zero-based offset from the beginning of the file of the first character in the region.

min=0
charLength integer

The length of the region in characters.

min=0
byteOffset integer

The zero-based offset from the beginning of the file of the first byte in the region.

min=0
byteLength integer

The length of the region in bytes.

min=0
snippet object

Represents content from an external file.

message object

Encapsulates a message intended to be read by the end user.

contextRegion object

A region within a file where a result was detected.

10 nested properties
startLine integer

The line number of the first character in the region.

min=1
startColumn integer

The column number of the first character in the region.

min=1
endLine integer

The line number of the last character in the region.

min=1
endColumn integer

The column number of the character following the end of the region.

min=1
charOffset integer

The zero-based offset from the beginning of the file of the first character in the region.

min=0
charLength integer

The length of the region in characters.

min=0
byteOffset integer

The zero-based offset from the beginning of the file of the first byte in the region.

min=0
byteLength integer

The length of the region in bytes.

min=0
snippet object

Represents content from an external file.

message object

Encapsulates a message intended to be read by the end user.

level enum

A value specifying the severity level of the notification.

Default: "warning"
Values: "note" "warning" "error"
threadId integer

The thread identifier of the code that generated the notification.

time string

The date and time at which the analysis tool generated the notification.

format=date-time
exception object
4 nested properties
kind string

A string that identifies the kind of exception, for example, the fully qualified type name of an object that was thrown, or the symbolic name of a signal.

message string

A plain text message that describes the exception.

stack object

A call stack that is relevant to a result.

3 nested properties
frames stackFrame[] required

An array of stack frames that represent a sequence of calls, rendered in reverse chronological order, that comprise the call stack.

minItems=1
message object

Encapsulates a message intended to be read by the end user.

properties object

Key/value pairs that provide additional information about the stack.

innerExceptions exception[]

An array of exception objects each of which is considered a cause of this exception.

properties object

Key/value pairs that provide additional information about the notification.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
physicalLocation object

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.

fileLocation object required

Specifies the location of a file.

2 nested properties
uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

id integer

Value that distinguishes this physical location from all other physical locations in this run object.

region object

A region within a file where a result was detected.

10 nested properties
startLine integer

The line number of the first character in the region.

min=1
startColumn integer

The column number of the first character in the region.

min=1
endLine integer

The line number of the last character in the region.

min=1
endColumn integer

The column number of the character following the end of the region.

min=1
charOffset integer

The zero-based offset from the beginning of the file of the first character in the region.

min=0
charLength integer

The length of the region in characters.

min=0
byteOffset integer

The zero-based offset from the beginning of the file of the first byte in the region.

min=0
byteLength integer

The length of the region in bytes.

min=0
snippet object

Represents content from an external file.

2 nested properties
text string

UTF-8-encoded content from a text file.

binary string

MIME Base64-encoded content from a binary file, or from a text file in its original encoding.

message object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

contextRegion object

A region within a file where a result was detected.

10 nested properties
startLine integer

The line number of the first character in the region.

min=1
startColumn integer

The column number of the first character in the region.

min=1
endLine integer

The line number of the last character in the region.

min=1
endColumn integer

The column number of the character following the end of the region.

min=1
charOffset integer

The zero-based offset from the beginning of the file of the first character in the region.

min=0
charLength integer

The length of the region in characters.

min=0
byteOffset integer

The zero-based offset from the beginning of the file of the first byte in the region.

min=0
byteLength integer

The length of the region in bytes.

min=0
snippet object

Represents content from an external file.

2 nested properties
text string

UTF-8-encoded content from a text file.

binary string

MIME Base64-encoded content from a binary file, or from a text file in its original encoding.

message object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

rectangle object

An area within an image.

top number

The Y coordinate of the top edge of the rectangle, measured in the image's natural units.

left number

The X coordinate of the left edge of the rectangle, measured in the image's natural units.

bottom number

The Y coordinate of the bottom edge of the rectangle, measured in the image's natural units.

right number

The X coordinate of the right edge of the rectangle, measured in the image's natural units.

message object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

region object

A region within a file where a result was detected.

startLine integer

The line number of the first character in the region.

min=1
startColumn integer

The column number of the first character in the region.

min=1
endLine integer

The line number of the last character in the region.

min=1
endColumn integer

The column number of the character following the end of the region.

min=1
charOffset integer

The zero-based offset from the beginning of the file of the first character in the region.

min=0
charLength integer

The length of the region in characters.

min=0
byteOffset integer

The zero-based offset from the beginning of the file of the first byte in the region.

min=0
byteLength integer

The length of the region in bytes.

min=0
snippet object

Represents content from an external file.

2 nested properties
text string

UTF-8-encoded content from a text file.

binary string

MIME Base64-encoded content from a binary file, or from a text file in its original encoding.

message object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

replacement object

The replacement of a single region of a file.

deletedRegion object required

A region within a file where a result was detected.

10 nested properties
startLine integer

The line number of the first character in the region.

min=1
startColumn integer

The column number of the first character in the region.

min=1
endLine integer

The line number of the last character in the region.

min=1
endColumn integer

The column number of the character following the end of the region.

min=1
charOffset integer

The zero-based offset from the beginning of the file of the first character in the region.

min=0
charLength integer

The length of the region in characters.

min=0
byteOffset integer

The zero-based offset from the beginning of the file of the first byte in the region.

min=0
byteLength integer

The length of the region in bytes.

min=0
snippet object

Represents content from an external file.

2 nested properties
text string

UTF-8-encoded content from a text file.

binary string

MIME Base64-encoded content from a binary file, or from a text file in its original encoding.

message object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

insertedContent object

Represents content from an external file.

2 nested properties
text string

UTF-8-encoded content from a text file.

binary string

MIME Base64-encoded content from a binary file, or from a text file in its original encoding.

resources object

Container for items that require localization.

messageStrings Record<string, string>

A dictionary, each of whose keys is a resource identifier and each of whose values is a localized string.

rules Record<string, object>

A dictionary, each of whose keys is a string and each of whose values is a 'rule' object, that describe all rules associated with an analysis tool or a specific run of an analysis tool.

result object

A result produced by an analysis tool.

ruleId string

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.

level enum

A value specifying the severity level of the result.

Values: "notApplicable" "pass" "note" "warning" "error" "open"
message object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

analysisTarget object

Specifies the location of a file.

2 nested properties
uri string required

A string containing a valid relative or absolute URI.

format=uri-reference
uriBaseId string

A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

locations location[]

One or more locations where the result occurred. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.

minItems=1uniqueItems=true
instanceGuid string

A stable, unique identifier for the result in the form of a GUID.

correlationGuid string

A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.

partialFingerprints Record<string, string>

A set of strings that contribute to the stable, unique identity of the result.

fingerprints Record<string, string>

A set of strings each of which individually defines a stable, unique identity for the result.

stacks stack[]

An array of 'stack' objects relevant to the result.

minItems=1uniqueItems=true
codeFlows codeFlow[]

An array of 'codeFlow' objects relevant to the result.

minItems=1uniqueItems=true
graphs graph[]

An array of one or more unique 'graph' objects.

minItems=1uniqueItems=true
graphTraversals graphTraversal[]

An array of one or more unique 'graphTraversal' objects.

minItems=1uniqueItems=true
relatedLocations location[]

A set of locations relevant to this result.

minItems=1uniqueItems=true
suppressionStates enum[]

A set of flags indicating one or more suppression conditions.

baselineState enum

The state of a result relative to a baseline of a previous run.

Values: "new" "existing" "absent"
attachments attachment[]

A set of files relevant to the result.

minItems=1uniqueItems=true
workItemUris string[]

The URIs of the work items associated with this result

minItems=1uniqueItems=true
conversionProvenance physicalLocation[]

An array of physicalLocation objects which specify the portions of an analysis tool's output that a converter transformed into the result object.

minItems=1uniqueItems=true
fixes fix[]

An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.

minItems=1uniqueItems=true
properties object

Key/value pairs that provide additional information about the result.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
rule object

Describes an analysis rule.

id string required

A stable, opaque identifier for the rule.

name object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

shortDescription object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

fullDescription object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

messageStrings Record<string, string>

A set of name/value pairs with arbitrary names. The value within each name/value pair consists of plain text interspersed with placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.

richMessageStrings Record<string, string>

A set of name/value pairs with arbitrary names. The value within each name/value pair consists of rich text interspersed with placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.

configuration object

Information about a rule that can be configured at runtime.

3 nested properties
enabled boolean

Specifies whether the rule will be evaluated during the scan.

defaultLevel enum

Specifies the default severity level of the result.

Default: "warning"
Values: "note" "warning" "error" "open"
parameters object

Contains configuration information specific to this rule.

1 nested properties
tags string[]

A set of distinct strings that provide additional configuration information.

Default:
[]
uniqueItems=true
helpUri string

A URI where the primary documentation for the rule can be found.

format=uri
help object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

properties object

Key/value pairs that provide additional information about the rule.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
ruleConfiguration object

Information about a rule that can be configured at runtime.

enabled boolean

Specifies whether the rule will be evaluated during the scan.

defaultLevel enum

Specifies the default severity level of the result.

Default: "warning"
Values: "note" "warning" "error" "open"
parameters object

Contains configuration information specific to this rule.

1 nested properties
tags string[]

A set of distinct strings that provide additional configuration information.

Default:
[]
uniqueItems=true
run object

Describes a single run of an analysis tool, and contains the output of that run.

tool object required

The analysis tool that was run.

9 nested properties
name string required

The name of the tool.

fullName string

The name of the tool along with its version and any other useful identifying information, such as its locale.

version string

The tool version, in whatever format the tool natively provides.

semanticVersion string

The tool version in the format specified by Semantic Versioning 2.0.

fileVersion string

The binary version of the tool's primary executable file (for operating systems such as Windows that provide that information).

pattern=[0-9]+(\.[0-9]+){3}
downloadUri string

The absolute URI from which the tool can be downloaded.

format=uri
sarifLoggerVersion string

A version that uniquely identifies the SARIF logging component that generated this file, if it is versioned separately from the tool.

language string

The tool language (expressed as an ISO 649 two-letter lowercase culture code) and region (expressed as an ISO 3166 two-letter uppercase subculture code associated with a country or region).

Default: "en-US"
properties object

Key/value pairs that provide additional information about the tool.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
invocations invocation[]

Describes the invocation of the analysis tool.

minItems=1uniqueItems=true
conversion object

Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.

3 nested properties
tool object required

The analysis tool that was run.

9 nested properties
name string required

The name of the tool.

fullName string

The name of the tool along with its version and any other useful identifying information, such as its locale.

version string

The tool version, in whatever format the tool natively provides.

semanticVersion string

The tool version in the format specified by Semantic Versioning 2.0.

fileVersion string

The binary version of the tool's primary executable file (for operating systems such as Windows that provide that information).

pattern=[0-9]+(\.[0-9]+){3}
downloadUri string

The absolute URI from which the tool can be downloaded.

format=uri
sarifLoggerVersion string

A version that uniquely identifies the SARIF logging component that generated this file, if it is versioned separately from the tool.

language string

The tool language (expressed as an ISO 649 two-letter lowercase culture code) and region (expressed as an ISO 3166 two-letter uppercase subculture code associated with a country or region).

Default: "en-US"
properties object

Key/value pairs that provide additional information about the tool.

invocation object

The runtime environment of the analysis tool run.

25 nested properties
commandLine string

The command line used to invoke the tool.

arguments string[]

An array of strings, containing in order the command line arguments passed to the tool from the operating system.

responseFiles fileLocation[]

The locations of any response files specified on the tool's command line.

attachments attachment[]

A set of files relevant to the invocation of the tool.

minItems=1uniqueItems=true
startTime string

The date and time at which the run started. See "Date/time properties" in the SARIF spec for the required format.

format=date-time
endTime string

The date and time at which the run ended. See "Date/time properties" in the SARIF spec for the required format.

format=date-time
exitCode integer

The process exit code.

toolNotifications notification[]

A list of runtime conditions detected by the tool during the analysis.

configurationNotifications notification[]

A list of conditions detected by the tool that are relevant to the tool's configuration.

exitCodeDescription string

The reason for the process exit.

exitSignalName string

The name of the signal that caused the process to exit.

exitSignalNumber integer

The numeric value of the signal that caused the process to exit.

processStartFailureMessage string

The reason given by the operating system that the process failed to start.

toolExecutionSuccessful boolean

A value indicating whether the tool's execution completed successfully.

machine string

The machine that hosted the analysis tool run.

account string

The account that ran the analysis tool.

processId integer

The process id for the analysis tool run.

executableLocation object

Specifies the location of a file.

workingDirectory object

Specifies the location of a file.

environmentVariables object

The environment variables associated with the analysis tool process, expressed as key/value pairs.

Default:
{}
stdin object

Specifies the location of a file.

stdout object

Specifies the location of a file.

stderr object

Specifies the location of a file.

stdoutStderr object

Specifies the location of a file.

properties object

Key/value pairs that provide additional information about the invocation.

analysisToolLogFiles fileLocation[]

The locations of the analysis tool's per-run log files.

minItems=1uniqueItems=true
versionControlProvenance versionControlDetails[]

Specifies the revision in version control of the files that were scanned.

minItems=1uniqueItems=true
originalUriBaseIds Record<string, string>

The absolute URI specified by each uriBaseId symbol on the machine where the tool originally ran.

files Record<string, object>

A dictionary, each of whose keys is a URI and each of whose values is a file object.

logicalLocations Record<string, object>

A dictionary, each of whose keys specifies a logical location such as a namespace, type or function.

graphs graph[]

An array of one or more unique 'graph' objects.

minItems=1uniqueItems=true
results result[]

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.

minItems=0
resources object

Container for items that require localization.

2 nested properties
messageStrings Record<string, string>

A dictionary, each of whose keys is a resource identifier and each of whose values is a localized string.

rules Record<string, object>

A dictionary, each of whose keys is a string and each of whose values is a 'rule' object, that describe all rules associated with an analysis tool or a specific run of an analysis tool.

instanceGuid string

A stable, unique identifier for the run, in the form of a GUID.

correlationGuid string

A stable, unique identifier for the class of related runs to which this run belongs, in the form of a GUID.

logicalId string

A logical identifier for a run, for example, 'nightly Clang analyzer run'. Multiple runs of the same type can have the same logical id.

description object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

automationLogicalId string

A global identifier that allows the run to be correlated with other artifacts produced by a larger automation process.

baselineInstanceGuid string

The 'instanceGuid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.

architecture string

The hardware architecture for which the run was targeted.

richMessageMimeType string

The MIME type of all rich text message properties in the run. Default: "text/markdown;variant=GFM"

Default: "text/markdown;variant=GFM"
redactionToken string

The string used to replace sensitive information in a redaction-aware property.

defaultFileEncoding string

Specifies the default encoding for any file object that refers to a text file.

columnKind enum

Specifies the unit in which the tool measures columns.

Values: "utf16CodeUnits" "unicodeCodePoints"
properties object

Key/value pairs that provide additional information about the run.

1 nested properties
tags string[]

A set of distinct strings that provide additional information about the run.

Default:
[]
uniqueItems=true
stack object

A call stack that is relevant to a result.

frames stackFrame[] required

An array of stack frames that represent a sequence of calls, rendered in reverse chronological order, that comprise the call stack.

minItems=1
message object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

properties object

Key/value pairs that provide additional information about the stack.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
stackFrame object

A function call within a stack trace.

location object

A location within a programming artifact.

5 nested properties
physicalLocation object

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.

4 nested properties
fileLocation object required

Specifies the location of a file.

id integer

Value that distinguishes this physical location from all other physical locations in this run object.

region object

A region within a file where a result was detected.

contextRegion object

A region within a file where a result was detected.

fullyQualifiedLogicalName string

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.

message object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

annotations region[]

A set of regions relevant to the location.

minItems=1uniqueItems=true
properties object

Key/value pairs that provide additional information about the location.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
module string

The name of the module that contains the code of this stack frame.

threadId integer

The thread identifier of the stack frame.

address integer

The address of the method or function that is executing.

offset integer

The offset from the method or function that is executing.

parameters string[]

The parameters of the call that is executing.

properties object

Key/value pairs that provide additional information about the stack frame.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
threadFlow object
locations threadFlowLocation[] required

A temporally ordered array of 'threadFlowLocation' objects, each of which describes a location visited by the tool while producing the result.

minItems=1
id string

An string that uniquely identifies the threadFlow within the codeFlow in which it occurs.

message object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

properties object

Key/value pairs that provide additional information about the thread flow.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
threadFlowLocation object

A location visited by an analysis tool while simulating or monitoring the execution of a program.

step integer

The 0-based sequence number of the location in the code flow within which it occurs.

min=0
location object

A location within a programming artifact.

5 nested properties
physicalLocation object

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.

4 nested properties
fileLocation object required

Specifies the location of a file.

id integer

Value that distinguishes this physical location from all other physical locations in this run object.

region object

A region within a file where a result was detected.

contextRegion object

A region within a file where a result was detected.

fullyQualifiedLogicalName string

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.

message object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

annotations region[]

A set of regions relevant to the location.

minItems=1uniqueItems=true
properties object

Key/value pairs that provide additional information about the location.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
stack object

A call stack that is relevant to a result.

3 nested properties
frames stackFrame[] required

An array of stack frames that represent a sequence of calls, rendered in reverse chronological order, that comprise the call stack.

minItems=1
message object

Encapsulates a message intended to be read by the end user.

5 nested properties
text string

A plain text message string.

messageId string

The resource id for a plain text message string.

richText string

A rich text message string.

richMessageId string

The resource id for a rich text message string.

arguments string[]

An array of strings to substitute into the message string.

properties object

Key/value pairs that provide additional information about the stack.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
kind string

A string describing the type of this location.

module string

The name of the module that contains the code that is executing.

state object

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.

nestingLevel integer

An integer representing a containment hierarchy within the thread flow

executionOrder integer

An integer representing the temporal order in which execution reached this location.

timestamp string

The time at which this location was executed.

format=date-time
importance enum

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".

Values: "important" "essential" "unimportant"
properties object

Key/value pairs that provide additional information about the code location.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
tool object

The analysis tool that was run.

name string required

The name of the tool.

fullName string

The name of the tool along with its version and any other useful identifying information, such as its locale.

version string

The tool version, in whatever format the tool natively provides.

semanticVersion string

The tool version in the format specified by Semantic Versioning 2.0.

fileVersion string

The binary version of the tool's primary executable file (for operating systems such as Windows that provide that information).

pattern=[0-9]+(\.[0-9]+){3}
downloadUri string

The absolute URI from which the tool can be downloaded.

format=uri
sarifLoggerVersion string

A version that uniquely identifies the SARIF logging component that generated this file, if it is versioned separately from the tool.

language string

The tool language (expressed as an ISO 649 two-letter lowercase culture code) and region (expressed as an ISO 3166 two-letter uppercase subculture code associated with a country or region).

Default: "en-US"
properties object

Key/value pairs that provide additional information about the tool.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true
versionControlDetails object

Specifies the information necessary to retrieve a desired revision from a version control system.

uri string required

The absolute URI of the repository.

format=uri
revisionId string

A string that uniquely and permanently identifies the revision within the repository.

branch string

The name of a branch containing the revision.

tag string

A tag that has been applied to the revision.

timestamp string

The date and time at which the revision was created.

format=date-time
properties object

Key/value pairs that provide additional information about the revision.

1 nested properties
tags string[]

A set of distinct strings that provide additional information.

Default:
[]
uniqueItems=true