schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
2021-07.json
items
The value can be either text or an expression.
{"type": "string"}
2021-07.json
overrides
The headers to be added to the outbound downstream response. If the header already exists, its value is replaced. The value can be either text or an expression.
{"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}}
2021-07.json
items
The value can be either text or an expression.
{"type": "string"}
2021-07.json
discards
The inbound upstream headers that should be discarded.
{"type": "array", "items": {"type": "string"}}
2021-07.json
items
The name of the header to be discarded.
{"type": "string"}
sarif-2.1.0.json
Static Analysis Results Format (SARIF) Version 2.1.0 JSON Schema: a standard format for the output of static analysis tools.
{"$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": {"address": {"additionalProperties": false, "type": "object", "properties": {"absoluteAddress": {"type": "integer", "minimum": -1, "default": -1}, "relativeAddress": {"type": "integer"}, "length": {"type": "integer"}, "...
sarif-2.1.0.json
address
A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).
{"additionalProperties": false, "type": "object", "properties": {"absoluteAddress": {"type": "integer", "minimum": -1, "default": -1}, "relativeAddress": {"type": "integer"}, "length": {"type": "integer"}, "kind": {"type": "string"}, "name": {"type": "string"}, "fullyQualifiedName": {"type": "string"}, "offsetFromParen...
sarif-2.1.0.json
absoluteAddress
The address expressed as a byte offset from the start of the addressable region.
{"type": "integer", "minimum": -1, "default": -1}
sarif-2.1.0.json
relativeAddress
The address expressed as a byte offset from the absolute address of the top-most parent object.
{"type": "integer"}
sarif-2.1.0.json
length
The number of bytes in this range of addresses.
{"type": "integer"}
sarif-2.1.0.json
kind
An open-ended string that identifies the address kind. 'data', 'function', 'header','instruction', 'module', 'page', 'section', 'segment', 'stack', 'stackFrame', 'table' are well-known values.
{"type": "string"}
sarif-2.1.0.json
name
A name that is associated with the address, e.g., '.text'.
{"type": "string"}
sarif-2.1.0.json
fullyQualifiedName
A human-readable fully qualified name that is associated with the address.
{"type": "string"}
sarif-2.1.0.json
offsetFromParent
The byte offset of this address from the absolute or relative address of the parent object.
{"type": "integer"}
sarif-2.1.0.json
index
The index within run.addresses of the cached object for this address.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0.json
parentIndex
The index within run.addresses of the parent object.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0.json
properties
Key/value pairs that provide additional information about the address.
{}
sarif-2.1.0.json
artifact
A single artifact. In some cases, this artifact might be nested within another artifact.
{"additionalProperties": false, "type": "object", "properties": {"location": {}, "parentIndex": {"type": "integer", "default": -1, "minimum": -1}, "offset": {"type": "integer", "minimum": 0}, "length": {"type": "integer", "default": -1, "minimum": -1}, "roles": {"type": "array", "minItems": 0, "uniqueItems": true, "def...
sarif-2.1.0.json
description
A short description of the artifact.
{}
sarif-2.1.0.json
location
The location of the artifact.
{}
sarif-2.1.0.json
parentIndex
Identifies the index of the immediate parent of the artifact, if this artifact is nested.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0.json
offset
The offset in bytes of the artifact within its containing artifact.
{"type": "integer", "minimum": 0}
sarif-2.1.0.json
length
The length of the artifact in bytes.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0.json
roles
The role or roles played by the artifact in the analysis.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {"enum": ["analysisTarget", "attachment", "responseFile", "resultFile", "standardStream", "tracedFile", "unmodified", "modified", "added", "deleted", "renamed", "uncontrolled", "driver", "extension", "translation", "taxonomy", "policy", "refe...
sarif-2.1.0.json
mimeType
The MIME type (RFC 2045) of the artifact.
{"type": "string", "pattern": "[^/]+/.+"}
sarif-2.1.0.json
contents
The contents of the artifact.
{}
sarif-2.1.0.json
encoding
Specifies the encoding for an artifact object that refers to a text file.
{"type": "string"}
sarif-2.1.0.json
sourceLanguage
Specifies the source language for any artifact object that refers to a text file that contains source code.
{"type": "string"}
sarif-2.1.0.json
hashes
A dictionary, each of whose keys is the name of a hash function and each of whose values is the hashed value of the artifact produced by the specified hash function.
{"type": "object", "additionalProperties": {"type": "string"}}
sarif-2.1.0.json
lastModifiedTimeUtc
The Coordinated Universal Time (UTC) date and time at which the artifact was most recently modified. See "Date/time properties" in the SARIF spec for the required format.
{"type": "string", "format": "date-time"}
sarif-2.1.0.json
properties
Key/value pairs that provide additional information about the artifact.
{}
sarif-2.1.0.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.json
artifactLocation
The location of the artifact to change.
{}
sarif-2.1.0.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.json
properties
Key/value pairs that provide additional information about the change.
{}
sarif-2.1.0.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.json
text
UTF-8-encoded content from a text artifact.
{"type": "string"}
sarif-2.1.0.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.json
rendered
An alternate rendered representation of the artifact (e.g., a decompiled representation of a binary region).
{}
sarif-2.1.0.json
properties
Key/value pairs that provide additional information about the artifact content.
{}
sarif-2.1.0.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.json
uri
A string containing a valid relative or absolute URI.
{"type": "string", "format": "uri-reference"}
sarif-2.1.0.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.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.json
description
A short description of the artifact location.
{}
sarif-2.1.0.json
properties
Key/value pairs that provide additional information about the artifact location.
{}
sarif-2.1.0.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": ["artifac...
sarif-2.1.0.json
description
A message describing the role played by the attachment.
{}
sarif-2.1.0.json
artifactLocation
The location of the attachment.
{}
sarif-2.1.0.json
regions
An array of regions of interest within the attachment.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0.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.json
properties
Key/value pairs that provide additional information about the attachment.
{}
sarif-2.1.0.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.json
message
A message relevant to the code flow.
{}
sarif-2.1.0.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.json
properties
Key/value pairs that provide additional information about the code flow.
{}
sarif-2.1.0.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.json
configuration
Specifies how the rule or notification was configured during the scan.
{}
sarif-2.1.0.json
descriptor
A reference used to locate the descriptor whose configuration was overridden.
{}
sarif-2.1.0.json
properties
Key/value pairs that provide additional information about the configuration override.
{}
sarif-2.1.0.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.json
tool
A tool object that describes the converter.
{}
sarif-2.1.0.json
invocation
An invocation object that describes the invocation of the converter.
{}
sarif-2.1.0.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.json
properties
Key/value pairs that provide additional information about the conversion.
{}
sarif-2.1.0.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.json
id
A string that uniquely identifies the edge within its graph.
{"type": "string"}
sarif-2.1.0.json
label
A short description of the edge.
{}
sarif-2.1.0.json
sourceNodeId
Identifies the source node (the node at which the edge starts).
{"type": "string"}
sarif-2.1.0.json
targetNodeId
Identifies the target node (the node at which the edge ends).
{"type": "string"}
sarif-2.1.0.json
properties
Key/value pairs that provide additional information about the edge.
{}
sarif-2.1.0.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.json
edgeId
Identifies the edge being traversed.
{"type": "string"}
sarif-2.1.0.json
message
A message to display to the user as the edge is traversed.
{}
sarif-2.1.0.json
finalState
The values of relevant expressions after the edge has been traversed.
{"type": "object", "additionalProperties": {}}
sarif-2.1.0.json
stepOverEdgeCount
The number of edge traversals necessary to return from a nested graph.
{"type": "integer", "minimum": 0}
sarif-2.1.0.json
properties
Key/value pairs that provide additional information about the edge traversal.
{}
sarif-2.1.0.json
exception
Describes a runtime exception encountered during the execution of an analysis tool.
{"type": "object", "additionalProperties": false, "properties": {"kind": {"type": "string"}, "message": {"type": "string"}, "stack": {}, "innerExceptions": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "properties": {}}}
sarif-2.1.0.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.json
message
A message that describes the exception.
{"type": "string"}
sarif-2.1.0.json
stack
The sequence of function calls leading to the exception.
{}
sarif-2.1.0.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.json
properties
Key/value pairs that provide additional information about the exception.
{}
sarif-2.1.0.json
externalProperties
The top-level element of an external property file.
{"type": "object", "additionalProperties": false, "properties": {"schema": {"type": "string", "format": "uri"}, "version": {"enum": ["2.1.0"]}, "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}$"}, "runGuid": {"type": "string", "pattern": "^...
sarif-2.1.0.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.json
version
The SARIF format version of this external properties object.
{"enum": ["2.1.0"]}
sarif-2.1.0.json
guid
A stable, unique identifer 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.json
runGuid
A stable, unique identifer 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.json
conversion
A conversion object that will be merged with a separate run.
{}
sarif-2.1.0.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.json
externalizedProperties
Key/value pairs that provide additional information that will be merged with a separate run.
{}
sarif-2.1.0.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.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.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.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.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.json
taxonomies
Tool taxonomies that will be merged with a separate run.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0.json
driver
The analysis tool object that will be merged with a separate run.
{}
sarif-2.1.0.json
extensions
Tool extensions that will be merged with a separate run.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0.json
policies
Tool policies that will be merged with a separate run.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}