schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
sarif-2.1.0-rtm.3.json
artifactChange
A change to a single artifact.
{"additionalProperties": false, "type": "object", "properties": {"artifactLocation": {}, "replacements": {"type": "array", "minItems": 1, "uniqueItems": false, "items": {}}, "properties": {}}, "required": ["artifactLocation", "replacements"]}
sarif-2.1.0-rtm.3.json
artifactLocation
The location of the artifact to change.
{}
sarif-2.1.0-rtm.3.json
replacements
An array of replacement objects, each of which represents the replacement of a single region in a single artifact specified by 'artifactLocation'.
{"type": "array", "minItems": 1, "uniqueItems": false, "items": {}}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the change.
{}
sarif-2.1.0-rtm.3.json
artifactContent
Represents the contents of an artifact.
{"type": "object", "additionalProperties": false, "properties": {"text": {"type": "string"}, "binary": {"type": "string"}, "rendered": {}, "properties": {}}}
sarif-2.1.0-rtm.3.json
text
UTF-8-encoded content from a text artifact.
{"type": "string"}
sarif-2.1.0-rtm.3.json
binary
MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.
{"type": "string"}
sarif-2.1.0-rtm.3.json
rendered
An alternate rendered representation of the artifact (e.g., a decompiled representation of a binary region).
{}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the artifact content.
{}
sarif-2.1.0-rtm.3.json
artifactLocation
Specifies the location of an artifact.
{"additionalProperties": false, "type": "object", "properties": {"uri": {"type": "string", "format": "uri-reference"}, "uriBaseId": {"type": "string"}, "index": {"type": "integer", "default": -1, "minimum": -1}, "properties": {}}}
sarif-2.1.0-rtm.3.json
uri
A string containing a valid relative or absolute URI.
{"type": "string", "format": "uri-reference"}
sarif-2.1.0-rtm.3.json
uriBaseId
A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.
{"type": "string"}
sarif-2.1.0-rtm.3.json
index
The index within the run artifacts array of the artifact object associated with the artifact location.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0-rtm.3.json
description
A short description of the artifact location.
{}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the artifact location.
{}
sarif-2.1.0-rtm.3.json
attachment
An artifact relevant to a result.
{"type": "object", "additionalProperties": false, "properties": {"artifactLocation": {}, "regions": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "rectangles": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}, "required": ["artifactLocation"]}
sarif-2.1.0-rtm.3.json
description
A message describing the role played by the attachment.
{}
sarif-2.1.0-rtm.3.json
artifactLocation
The location of the attachment.
{}
sarif-2.1.0-rtm.3.json
regions
An array of regions of interest within the attachment.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
rectangles
An array of rectangles specifying areas of interest within the image.
{"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 attachment.
{}
sarif-2.1.0-rtm.3.json
codeFlow
A set of threadFlows which together describe a pattern of code execution relevant to detecting a result.
{"additionalProperties": false, "type": "object", "properties": {"message": {}, "threadFlows": {"type": "array", "minItems": 1, "uniqueItems": false, "items": {}}, "properties": {}}, "required": ["threadFlows"]}
sarif-2.1.0-rtm.3.json
message
A message relevant to the code flow.
{}
sarif-2.1.0-rtm.3.json
threadFlows
An array of one or more unique threadFlow objects, each of which describes the progress of a program through a thread of execution.
{"type": "array", "minItems": 1, "uniqueItems": false, "items": {}}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the code flow.
{}
sarif-2.1.0-rtm.3.json
configurationOverride
Information about how a specific rule or notification was reconfigured at runtime.
{"type": "object", "additionalProperties": false, "properties": {"configuration": {}, "descriptor": {}, "properties": {}}, "required": ["configuration", "descriptor"]}
sarif-2.1.0-rtm.3.json
configuration
Specifies how the rule or notification was configured during the scan.
{}
sarif-2.1.0-rtm.3.json
descriptor
A reference used to locate the descriptor whose configuration was overridden.
{}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the configuration override.
{}
sarif-2.1.0-rtm.3.json
conversion
Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.
{"additionalProperties": false, "type": "object", "properties": {"tool": {}, "invocation": {}, "analysisToolLogFiles": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}, "required": ["tool"]}
sarif-2.1.0-rtm.3.json
tool
A tool object that describes the converter.
{}
sarif-2.1.0-rtm.3.json
invocation
An invocation object that describes the invocation of the converter.
{}
sarif-2.1.0-rtm.3.json
analysisToolLogFiles
The locations of the analysis tool's per-run log files.
{"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 conversion.
{}
sarif-2.1.0-rtm.3.json
edge
Represents a directed edge in a graph.
{"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "label": {}, "sourceNodeId": {"type": "string"}, "targetNodeId": {"type": "string"}, "properties": {}}, "required": ["id", "sourceNodeId", "targetNodeId"]}
sarif-2.1.0-rtm.3.json
id
A string that uniquely identifies the edge within its graph.
{"type": "string"}
sarif-2.1.0-rtm.3.json
label
A short description of the edge.
{}
sarif-2.1.0-rtm.3.json
sourceNodeId
Identifies the source node (the node at which the edge starts).
{"type": "string"}
sarif-2.1.0-rtm.3.json
targetNodeId
Identifies the target node (the node at which the edge ends).
{"type": "string"}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the edge.
{}
sarif-2.1.0-rtm.3.json
edgeTraversal
Represents the traversal of a single edge during a graph traversal.
{"type": "object", "additionalProperties": false, "properties": {"edgeId": {"type": "string"}, "message": {}, "finalState": {"type": "object", "additionalProperties": {}}, "stepOverEdgeCount": {"type": "integer", "minimum": 0}, "properties": {}}, "required": ["edgeId"]}
sarif-2.1.0-rtm.3.json
edgeId
Identifies the edge being traversed.
{"type": "string"}
sarif-2.1.0-rtm.3.json
message
A message to display to the user as the edge is traversed.
{}
sarif-2.1.0-rtm.3.json
finalState
The values of relevant expressions after the edge has been traversed.
{"type": "object", "additionalProperties": {}}
sarif-2.1.0-rtm.3.json
stepOverEdgeCount
The number of edge traversals necessary to return from a nested graph.
{"type": "integer", "minimum": 0}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the edge traversal.
{}
sarif-2.1.0-rtm.3.json
kind
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.
{"type": "string"}
sarif-2.1.0-rtm.3.json
message
A message that describes the exception.
{"type": "string"}
sarif-2.1.0-rtm.3.json
stack
The sequence of function calls leading to the exception.
{}
sarif-2.1.0-rtm.3.json
innerExceptions
An array of exception objects each of which is considered a cause of this exception.
{"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the exception.
{}
sarif-2.1.0-rtm.3.json
schema
The URI of the JSON schema corresponding to the version of the external property file format.
{"type": "string", "format": "uri"}
sarif-2.1.0-rtm.3.json
version
The SARIF format version of this external properties object.
{"enum": ["2.1.0"]}
sarif-2.1.0-rtm.3.json
guid
A stable, unique identifier for this external properties object, in the form of a GUID.
{"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"}
sarif-2.1.0-rtm.3.json
runGuid
A stable, unique identifier for the run associated with this external properties object, in the form of a GUID.
{"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"}
sarif-2.1.0-rtm.3.json
conversion
A conversion object that will be merged with a separate run.
{}
sarif-2.1.0-rtm.3.json
graphs
An array of graph objects that will be merged with a separate run.
{"type": "array", "minItems": 0, "default": [], "uniqueItems": true, "items": {}}
sarif-2.1.0-rtm.3.json
externalizedProperties
Key/value pairs that provide additional information that will be merged with a separate run.
{}
sarif-2.1.0-rtm.3.json
artifacts
An array of artifact objects that will be merged with a separate run.
{"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}
sarif-2.1.0-rtm.3.json
invocations
Describes the invocation of the analysis tool that will be merged with a separate run.
{"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
logicalLocations
An array of logical locations such as namespaces, types or functions that will be merged with a separate run.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
threadFlowLocations
An array of threadFlowLocation objects that will be merged with a separate run.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
results
An array of result objects that will be merged with a separate run.
{"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
taxonomies
Tool taxonomies that will be merged with a separate run.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
driver
The analysis tool object that will be merged with a separate run.
{}
sarif-2.1.0-rtm.3.json
extensions
Tool extensions that will be merged with a separate run.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
policies
Tool policies that will be merged with a separate run.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
translations
Tool translations that will be merged with a separate run.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
addresses
Addresses that will be merged with a separate run.
{"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
webRequests
Requests that will be merged with a separate run.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
webResponses
Responses that will be merged with a separate run.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the external properties.
{}
sarif-2.1.0-rtm.3.json
location
The location of the external property file.
{}
sarif-2.1.0-rtm.3.json
guid
A stable, unique identifier for the external property file 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
itemCount
A non-negative integer specifying the number of items contained in the external property file.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the external property file.
{}
sarif-2.1.0-rtm.3.json
externalPropertyFileReferences
References to external property files that should be inlined with the content of a root log file.
{"additionalProperties": false, "type": "object", "properties": {"conversion": {}, "graphs": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "externalizedProperties": {}, "artifacts": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "invocations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "logicalLocations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "threadFlowLocations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "results": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "taxonomies": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "addresses": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "driver": {}, "extensions": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "policies": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "translations": {"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": {}}, "properties": {}}}
sarif-2.1.0-rtm.3.json
conversion
An external property file containing a run.conversion object to be merged with the root log file.
{}
sarif-2.1.0-rtm.3.json
graphs
An array of external property files containing a run.graphs object to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
externalizedProperties
An external property file containing a run.properties object to be merged with the root log file.
{}
sarif-2.1.0-rtm.3.json
artifacts
An array of external property files containing run.artifacts arrays to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
invocations
An array of external property files containing run.invocations arrays to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
logicalLocations
An array of external property files containing run.logicalLocations arrays to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
threadFlowLocations
An array of external property files containing run.threadFlowLocations arrays to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
results
An array of external property files containing run.results arrays to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
taxonomies
An array of external property files containing run.taxonomies arrays to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
addresses
An array of external property files containing run.addresses arrays to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
driver
An external property file containing a run.driver object to be merged with the root log file.
{}
sarif-2.1.0-rtm.3.json
extensions
An array of external property files containing run.extensions arrays to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
policies
An array of external property files containing run.policies arrays to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
translations
An array of external property files containing run.translations arrays to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
webRequests
An array of external property files containing run.requests arrays to be merged with the root log file.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.3.json
webResponses
An array of external property files containing run.responses arrays to be merged with the root log file.
{"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 external property files.
{}
sarif-2.1.0-rtm.3.json
fix
A proposed fix for the problem represented by a result object. A fix specifies a set of artifacts to modify. For each artifact, it specifies a set of bytes to remove, and provides a set of new bytes to replace them.
{"additionalProperties": false, "type": "object", "properties": {"artifactChanges": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "properties": {}}, "required": ["artifactChanges"]}
sarif-2.1.0-rtm.3.json
description
A message that describes the proposed fix, enabling viewers to present the proposed change to an end user.
{}
sarif-2.1.0-rtm.3.json
artifactChanges
One or more artifact changes that comprise a fix for a result.
{"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the fix.
{}
sarif-2.1.0-rtm.3.json
graph
A network of nodes and directed edges that describes some aspect of the structure of the code (for example, a call graph).
{"type": "object", "additionalProperties": false, "properties": {"nodes": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "edges": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}}
sarif-2.1.0-rtm.3.json
description
A description of the graph.
{}