schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
sarif-2.1.0-rtm.6.json
index
The index within the run threadFlowLocations array.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0-rtm.6.json
location
The code location.
{}
sarif-2.1.0-rtm.6.json
stack
The call stack leading to this location.
{}
sarif-2.1.0-rtm.6.json
kinds
A set of distinct strings that categorize the thread flow location. Well-known kinds include 'acquire', 'release', 'enter', 'exit', 'call', 'return', 'branch', 'implicit', 'false', 'true', 'caution', 'danger', 'unknown', 'unreachable', 'taint', 'function', 'handler', 'lock', 'memory', 'resource', 'scope' and 'value'.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {"type": "string"}}
sarif-2.1.0-rtm.6.json
taxa
An array of references to rule or taxonomy reporting descriptors that are applicable to the thread flow location.
{"type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": {}}
sarif-2.1.0-rtm.6.json
module
The name of the module that contains the code that is executing.
{"type": "string"}
sarif-2.1.0-rtm.6.json
state
A dictionary, each of whose keys specifies a variable or expression, the associated value of which represents the variable or expression value. For an annotation of kind 'continuation', for example, this dictionary might hold the current assumed values of a set of global variables.
{"type": "object", "additionalProperties": {}}
sarif-2.1.0-rtm.6.json
nestingLevel
An integer representing a containment hierarchy within the thread flow.
{"type": "integer", "minimum": 0}
sarif-2.1.0-rtm.6.json
executionOrder
An integer representing the temporal order in which execution reached this location.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0-rtm.6.json
executionTimeUtc
The Coordinated Universal Time (UTC) date and time at which this location was executed.
{"type": "string", "format": "date-time"}
sarif-2.1.0-rtm.6.json
importance
Specifies the importance of this location in understanding the code flow in which it occurs. The order from most to least important is "essential", "important", "unimportant". Default: "important".
{"enum": ["important", "essential", "unimportant"], "default": "important"}
sarif-2.1.0-rtm.6.json
webRequest
A web request associated with this thread flow location.
{}
sarif-2.1.0-rtm.6.json
webResponse
A web response associated with this thread flow location.
{}
sarif-2.1.0-rtm.6.json
properties
Key/value pairs that provide additional information about the threadflow location.
{}
sarif-2.1.0-rtm.6.json
tool
The analysis tool that was run.
{"additionalProperties": false, "type": "object", "properties": {"driver": {}, "extensions": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}, "required": ["driver"]}
sarif-2.1.0-rtm.6.json
driver
The analysis tool that was run.
{}
sarif-2.1.0-rtm.6.json
extensions
Tool extensions that contributed to or reconfigured the analysis tool that was run.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
properties
Key/value pairs that provide additional information about the tool.
{}
sarif-2.1.0-rtm.6.json
toolComponent
A component, such as a plug-in or the driver, of the analysis tool that was run.
{"additionalProperties": false, "type": "object", "properties": {"guid": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "organization": {"type": "string"}, "product": {"type": "string"}, "productSuite": {"type": "string"}, "shortDescription": {}, "fullDescription": {}, "fullName": {"type": "string"}, "version": {"type": "string"}, "semanticVersion": {"type": "string"}, "dottedQuadFileVersion": {"type": "string", "pattern": "[0-9]+(\\.[0-9]+){3}"}, "releaseDateUtc": {"type": "string"}, "downloadUri": {"type": "string", "format": "uri"}, "informationUri": {"type": "string", "format": "uri"}, "globalMessageStrings": {"type": "object", "additionalProperties": {}}, "notifications": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "rules": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "taxa": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "locations": {"type": "array", "minItems": 0, "default": [], "items": {}}, "language": {"type": "string", "default": "en-US", "pattern": "^[a-zA-Z]{2}(-[a-zA-Z]{2})?$"}, "contents": {"type": "array", "uniqueItems": true, "default": ["localizedData", "nonLocalizedData"], "items": {"enum": ["localizedData", "nonLocalizedData"]}}, "isComprehensive": {"type": "boolean", "default": false}, "localizedDataSemanticVersion": {"type": "string"}, "minimumRequiredLocalizedDataSemanticVersion": {"type": "string"}, "associatedComponent": {}, "translationMetadata": {}, "supportedTaxonomies": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}, "required": ["name"]}
sarif-2.1.0-rtm.6.json
guid
A unique identifier for the tool component in the form of a GUID.
{"type": "string", "format": "uuid"}
sarif-2.1.0-rtm.6.json
name
The name of the tool component.
{"type": "string"}
sarif-2.1.0-rtm.6.json
organization
The organization or company that produced the tool component.
{"type": "string"}
sarif-2.1.0-rtm.6.json
product
A product suite to which the tool component belongs.
{"type": "string"}
sarif-2.1.0-rtm.6.json
productSuite
A localizable string containing the name of the suite of products to which the tool component belongs.
{"type": "string"}
sarif-2.1.0-rtm.6.json
shortDescription
A brief description of the tool component.
{}
sarif-2.1.0-rtm.6.json
fullDescription
A comprehensive description of the tool component.
{}
sarif-2.1.0-rtm.6.json
fullName
The name of the tool component along with its version and any other useful identifying information, such as its locale.
{"type": "string"}
sarif-2.1.0-rtm.6.json
version
The tool component version, in whatever format the component natively provides.
{"type": "string"}
sarif-2.1.0-rtm.6.json
semanticVersion
The tool component version in the format specified by Semantic Versioning 2.0.
{"type": "string"}
sarif-2.1.0-rtm.6.json
dottedQuadFileVersion
The binary version of the tool component's primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).
{"type": "string", "pattern": "[0-9]+(\\.[0-9]+){3}"}
sarif-2.1.0-rtm.6.json
releaseDateUtc
A string specifying the UTC date (and optionally, the time) of the component's release.
{"type": "string"}
sarif-2.1.0-rtm.6.json
downloadUri
The absolute URI from which the tool component can be downloaded.
{"type": "string", "format": "uri"}
sarif-2.1.0-rtm.6.json
informationUri
The absolute URI at which information about this version of the tool component can be found.
{"type": "string", "format": "uri"}
sarif-2.1.0-rtm.6.json
globalMessageStrings
A dictionary, each of whose keys is a resource identifier and each of whose values is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.
{"type": "object", "additionalProperties": {}}
sarif-2.1.0-rtm.6.json
notifications
An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
rules
An array of reportingDescriptor objects relevant to the analysis performed by the tool component.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
taxa
An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
locations
An array of the artifactLocation objects associated with the tool component.
{"type": "array", "minItems": 0, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
language
The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).
{"type": "string", "default": "en-US", "pattern": "^[a-zA-Z]{2}(-[a-zA-Z]{2})?$"}
sarif-2.1.0-rtm.6.json
contents
The kinds of data contained in this object.
{"type": "array", "uniqueItems": true, "default": ["localizedData", "nonLocalizedData"], "items": {"enum": ["localizedData", "nonLocalizedData"]}}
sarif-2.1.0-rtm.6.json
isComprehensive
Specifies whether this object contains a complete definition of the localizable and/or non-localizable data for this component, as opposed to including only data that is relevant to the results persisted to this log file.
{"type": "boolean", "default": false}
sarif-2.1.0-rtm.6.json
localizedDataSemanticVersion
The semantic version of the localized strings defined in this component; maintained by components that provide translations.
{"type": "string"}
sarif-2.1.0-rtm.6.json
minimumRequiredLocalizedDataSemanticVersion
The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.
{"type": "string"}
sarif-2.1.0-rtm.6.json
associatedComponent
The component which is strongly associated with this component. For a translation, this refers to the component which has been translated. For an extension, this is the driver that provides the extension's plugin model.
{}
sarif-2.1.0-rtm.6.json
translationMetadata
Translation metadata, required for a translation, not populated by other component types.
{}
sarif-2.1.0-rtm.6.json
supportedTaxonomies
An array of toolComponentReference objects to declare the taxonomies supported by the tool component.
{"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}
sarif-2.1.0-rtm.6.json
properties
Key/value pairs that provide additional information about the tool component.
{}
sarif-2.1.0-rtm.6.json
toolComponentReference
Identifies a particular toolComponent object, either the driver or an extension.
{"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string"}, "index": {"type": "integer", "default": -1, "minimum": -1}, "guid": {"type": "string", "format": "uuid"}, "properties": {}}}
sarif-2.1.0-rtm.6.json
name
The 'name' property of the referenced toolComponent.
{"type": "string"}
sarif-2.1.0-rtm.6.json
index
An index into the referenced toolComponent in tool.extensions.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0-rtm.6.json
guid
The 'guid' property of the referenced toolComponent.
{"type": "string", "format": "uuid"}
sarif-2.1.0-rtm.6.json
properties
Key/value pairs that provide additional information about the toolComponentReference.
{}
sarif-2.1.0-rtm.6.json
translationMetadata
Provides additional metadata related to translation.
{"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string"}, "fullName": {"type": "string"}, "shortDescription": {}, "fullDescription": {}, "downloadUri": {"type": "string", "format": "uri"}, "informationUri": {"type": "string", "format": "uri"}, "properties": {}}, "required": ["name"]}
sarif-2.1.0-rtm.6.json
name
The name associated with the translation metadata.
{"type": "string"}
sarif-2.1.0-rtm.6.json
fullName
The full name associated with the translation metadata.
{"type": "string"}
sarif-2.1.0-rtm.6.json
shortDescription
A brief description of the translation metadata.
{}
sarif-2.1.0-rtm.6.json
fullDescription
A comprehensive description of the translation metadata.
{}
sarif-2.1.0-rtm.6.json
downloadUri
The absolute URI from which the translation metadata can be downloaded.
{"type": "string", "format": "uri"}
sarif-2.1.0-rtm.6.json
informationUri
The absolute URI from which information related to the translation metadata can be downloaded.
{"type": "string", "format": "uri"}
sarif-2.1.0-rtm.6.json
properties
Key/value pairs that provide additional information about the translation metadata.
{}
sarif-2.1.0-rtm.6.json
versionControlDetails
Specifies the information necessary to retrieve a desired revision from a version control system.
{"type": "object", "additionalProperties": false, "properties": {"repositoryUri": {"type": "string", "format": "uri"}, "revisionId": {"type": "string"}, "branch": {"type": "string"}, "revisionTag": {"type": "string"}, "asOfTimeUtc": {"type": "string", "format": "date-time"}, "mappedTo": {}, "properties": {}}, "required": ["repositoryUri"]}
sarif-2.1.0-rtm.6.json
repositoryUri
The absolute URI of the repository.
{"type": "string", "format": "uri"}
sarif-2.1.0-rtm.6.json
revisionId
A string that uniquely and permanently identifies the revision within the repository.
{"type": "string"}
sarif-2.1.0-rtm.6.json
branch
The name of a branch containing the revision.
{"type": "string"}
sarif-2.1.0-rtm.6.json
revisionTag
A tag that has been applied to the revision.
{"type": "string"}
sarif-2.1.0-rtm.6.json
asOfTimeUtc
A Coordinated Universal Time (UTC) date and time that can be used to synchronize an enlistment to the state of the repository at that time.
{"type": "string", "format": "date-time"}
sarif-2.1.0-rtm.6.json
mappedTo
The location in the local file system to which the root of the repository was mapped at the time of the analysis.
{}
sarif-2.1.0-rtm.6.json
properties
Key/value pairs that provide additional information about the version control details.
{}
sarif-2.1.0-rtm.6.json
webRequest
Describes an HTTP request.
{"type": "object", "additionalProperties": false, "properties": {"index": {"type": "integer", "default": -1, "minimum": -1}, "protocol": {"type": "string"}, "version": {"type": "string"}, "target": {"type": "string"}, "method": {"type": "string"}, "headers": {"type": "object", "additionalProperties": {"type": "string"}}, "parameters": {"type": "object", "additionalProperties": {"type": "string"}}, "body": {}, "properties": {}}}
sarif-2.1.0-rtm.6.json
index
The index within the run.webRequests array of the request object associated with this result.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0-rtm.6.json
protocol
The request protocol. Example: 'http'.
{"type": "string"}
sarif-2.1.0-rtm.6.json
version
The request version. Example: '1.1'.
{"type": "string"}
sarif-2.1.0-rtm.6.json
target
The target of the request.
{"type": "string"}
sarif-2.1.0-rtm.6.json
method
The HTTP method. Well-known values are 'GET', 'PUT', 'POST', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'.
{"type": "string"}
sarif-2.1.0-rtm.6.json
headers
The request headers.
{"type": "object", "additionalProperties": {"type": "string"}}
sarif-2.1.0-rtm.6.json
parameters
The request parameters.
{"type": "object", "additionalProperties": {"type": "string"}}
sarif-2.1.0-rtm.6.json
body
The body of the request.
{}
sarif-2.1.0-rtm.6.json
properties
Key/value pairs that provide additional information about the request.
{}
sarif-2.1.0-rtm.6.json
webResponse
Describes the response to an HTTP request.
{"type": "object", "additionalProperties": false, "properties": {"index": {"type": "integer", "default": -1, "minimum": -1}, "protocol": {"type": "string"}, "version": {"type": "string"}, "statusCode": {"type": "integer"}, "reasonPhrase": {"type": "string"}, "headers": {"type": "object", "additionalProperties": {"type": "string"}}, "body": {}, "noResponseReceived": {"type": "boolean", "default": false}, "properties": {}}}
sarif-2.1.0-rtm.6.json
index
The index within the run.webResponses array of the response object associated with this result.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0-rtm.6.json
protocol
The response protocol. Example: 'http'.
{"type": "string"}
sarif-2.1.0-rtm.6.json
version
The response version. Example: '1.1'.
{"type": "string"}
sarif-2.1.0-rtm.6.json
statusCode
The response status code. Example: 451.
{"type": "integer"}
sarif-2.1.0-rtm.6.json
reasonPhrase
The response reason. Example: 'Not found'.
{"type": "string"}
sarif-2.1.0-rtm.6.json
headers
The response headers.
{"type": "object", "additionalProperties": {"type": "string"}}
sarif-2.1.0-rtm.6.json
body
The body of the response.
{}
sarif-2.1.0-rtm.6.json
noResponseReceived
Specifies whether a response was received from the server.
{"type": "boolean", "default": false}
sarif-2.1.0-rtm.6.json
properties
Key/value pairs that provide additional information about the response.
{}
sarif-2.1.0-rtm.6.json
$schema
The URI of the JSON schema corresponding to the version.
{"type": "string", "format": "uri"}
sarif-2.1.0-rtm.6.json
version
The SARIF format version of this log file.
{"enum": ["2.1.0"]}
sarif-2.1.0-rtm.6.json
runs
The set of runs contained in this log file.
{"type": "array", "minItems": 0, "uniqueItems": false, "items": {}}
sarif-2.1.0-rtm.6.json
inlineExternalProperties
References to external property files that share data between runs.
{"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}
sarif-2.1.0-rtm.6.json
properties
Key/value pairs that provide additional information about the log file.
{}
prometheus.rules.json
Prometheus rules file
{"$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": {"duration": {"type": ["string", "null"], "pattern": "^([0-9]+y)?([0-9]+w)?([0-9]+d)?([0-9]+h)?([0-9]+m)?([0-9]+s)?([0-9]+ms)?$", "minLength": 1}, "label_name": {"type": "string", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$"}, "label_value": {"type": "string"}, "labels": {"type": ["object", "null"], "patternProperties": {"^[a-zA-Z_][a-zA-Z0-9_]*$": {}}, "additionalProperties": false}, "tmpl_string": {"type": "string"}, "annotations": {"type": ["object", "null"], "patternProperties": {"^[a-zA-Z_][a-zA-Z0-9_]*$": {}}, "additionalProperties": false}, "recording_rule": {"type": "object", "properties": {"record": {"type": "string"}, "expr": {"type": "string"}, "labels": {}}, "required": ["record", "expr"], "additionalProperties": false}, "alerting_rule": {"type": "object", "properties": {"alert": {"type": "string"}, "expr": {"type": "string"}, "for": {}, "labels": {}, "annotations": {}}, "required": ["alert", "expr"], "additionalProperties": false}}, "properties": {"groups": {"type": ["array", "null"], "items": {"type": "object", "properties": {"name": {"type": "string"}, "interval": {}, "limit": {"type": ["integer", "null"], "default": 0}, "rules": {"type": ["array", "null"], "items": {"oneOf": [{}, {}]}}}, "required": ["name"], "additionalProperties": false}}}, "type": ["object", "null"]}
prometheus.rules.json
tmpl_string
A string which is template-expanded before usage.
{"type": "string"}
prometheus.rules.json
record
The name of the time series to output to. Must be a valid metric name.
{"type": "string"}
prometheus.rules.json
expr
The PromQL expression to evaluate. Every evaluation cycle this is evaluated at the current time, and the result recorded as a new set of time series with the metric name as given by 'record'.
{"type": "string"}
prometheus.rules.json
labels
Labels to add or overwrite before storing the result.
{}
prometheus.rules.json
alert
The name of the alert. Must be a valid metric name.
{"type": "string"}
prometheus.rules.json
expr
The PromQL expression to evaluate. Every evaluation cycle this is evaluated at the current time, and all resultant time series become pending/firing alerts.
{"type": "string"}