schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
eslintrc.json
no-useless-constructor
Disallow unnecessary constructors
{}
eslintrc.json
no-useless-rename
Disallow renaming import, export, and destructured assignments to the same name
{}
eslintrc.json
no-var
Require let or const instead of var
{}
eslintrc.json
object-shorthand
Require or disallow method and property shorthand syntax for object literals
{}
eslintrc.json
prefer-arrow-callback
Require arrow functions as callbacks
{}
eslintrc.json
prefer-const
Require const declarations for variables that are never reassigned after declared
{}
eslintrc.json
prefer-destructuring
Require destructuring from arrays and/or objects
{}
eslintrc.json
prefer-numeric-literals
Disallow parseInt() in favor of binary, octal, and hexadecimal literals
{}
eslintrc.json
prefer-reflect
Require Reflect methods where applicable
{}
eslintrc.json
prefer-rest-params
Require rest parameters instead of arguments
{}
eslintrc.json
prefer-spread
Require spread operators instead of .apply()
{}
eslintrc.json
prefer-template
Require template literals instead of string concatenation
{}
eslintrc.json
require-yield
Require generator functions to contain yield
{}
eslintrc.json
rest-spread-spacing
Enforce spacing between rest and spread operators and their expressions
{}
eslintrc.json
sort-imports
Enforce sorted import declarations within modules
{}
eslintrc.json
symbol-description
Require symbol descriptions
{}
eslintrc.json
template-curly-spacing
Require or disallow spacing around embedded expressions of template strings
{}
eslintrc.json
yield-star-spacing
Require or disallow spacing around the * in yield* expressions
{}
eslintrc.json
ecmaFeatures
By default, ESLint supports only ECMAScript 5 syntax. You can override that setting to enable support for ECMAScript 6 as well as JSX by using configuration settings.
{"type": "object", "properties": {"arrowFunctions": {"type": "boolean"}, "binaryLiterals": {"type": "boolean"}, "blockBindings": {"type": "boolean"}, "classes": {"type": "boolean"}, "defaultParams": {"type": "boolean"}, "destructuring": {"type": "boolean"}, "experimentalObjectRestSpread": {"type": "boolean"}, "forOf": {"type": "boolean"}, "generators": {"type": "boolean"}, "globalReturn": {"type": "boolean"}, "impliedStrict": {"type": "boolean"}, "jsx": {"type": "boolean"}, "modules": {"type": "boolean"}, "objectLiteralComputedProperties": {"type": "boolean"}, "objectLiteralDuplicateProperties": {"type": "boolean"}, "objectLiteralShorthandMethods": {"type": "boolean"}, "objectLiteralShorthandProperties": {"type": "boolean"}, "octalLiterals": {"type": "boolean"}, "regexUFlag": {"type": "boolean"}, "regexYFlag": {"type": "boolean"}, "restParams": {"type": "boolean"}, "spread": {"type": "boolean"}, "superInFunctions": {"type": "boolean"}, "templateStrings": {"type": "boolean"}, "unicodeCodePointEscapes": {"type": "boolean"}}}
eslintrc.json
experimentalObjectRestSpread
Enables support for the experimental object rest/spread properties (IMPORTANT: This is an experimental feature that may change significantly in the future. It's recommended that you do not write rules relying on this functionality unless you are willing to incur maintenance cost when it changes.)
{"type": "boolean"}
eslintrc.json
globalReturn
allow return statements in the global scope
{"type": "boolean"}
eslintrc.json
impliedStrict
enable global strict mode (if ecmaVersion is 5 or greater)
{"type": "boolean"}
eslintrc.json
jsx
enable JSX
{"type": "boolean"}
eslintrc.json
env
An environment defines global variables that are predefined.
{"type": "object", "properties": {"amd": {"type": "boolean"}, "applescript": {"type": "boolean"}, "atomtest": {"type": "boolean"}, "browser": {"type": "boolean"}, "commonjs": {"type": "boolean"}, "shared-node-browser": {"type": "boolean"}, "embertest": {"type": "boolean"}, "es6": {"type": "boolean"}, "greasemonkey": {"type": "boolean"}, "jasmine": {"type": "boolean"}, "jest": {"type": "boolean"}, "jquery": {"type": "boolean"}, "meteor": {"type": "boolean"}, "mocha": {"type": "boolean"}, "mongo": {"type": "boolean"}, "nashorn": {"type": "boolean"}, "node": {"type": "boolean"}, "phantomjs": {"type": "boolean"}, "prototypejs": {"type": "boolean"}, "protractor": {"type": "boolean"}, "qunit": {"type": "boolean"}, "serviceworker": {"type": "boolean"}, "shelljs": {"type": "boolean"}, "webextensions": {"type": "boolean"}, "worker": {"type": "boolean"}}}
eslintrc.json
amd
defines require() and define() as global variables as per the amd spec
{"type": "boolean"}
eslintrc.json
applescript
AppleScript global variables
{"type": "boolean"}
eslintrc.json
atomtest
Atom test helper globals
{"type": "boolean"}
eslintrc.json
browser
browser global variables
{"type": "boolean"}
eslintrc.json
commonjs
CommonJS global variables and CommonJS scoping (use this for browser-only code that uses Browserify/WebPack)
{"type": "boolean"}
eslintrc.json
shared-node-browser
Globals common to both Node and Browser
{"type": "boolean"}
eslintrc.json
embertest
Ember test helper globals
{"type": "boolean"}
eslintrc.json
es6
enable all ECMAScript 6 features except for modules
{"type": "boolean"}
eslintrc.json
greasemonkey
GreaseMonkey globals
{"type": "boolean"}
eslintrc.json
jasmine
adds all of the Jasmine testing global variables for version 1.3 and 2.0
{"type": "boolean"}
eslintrc.json
jest
Jest global variables
{"type": "boolean"}
eslintrc.json
jquery
jQuery global variables
{"type": "boolean"}
eslintrc.json
meteor
Meteor global variables
{"type": "boolean"}
eslintrc.json
mocha
adds all of the Mocha test global variables
{"type": "boolean"}
eslintrc.json
mongo
MongoDB global variables
{"type": "boolean"}
eslintrc.json
nashorn
Java 8 Nashorn global variables
{"type": "boolean"}
eslintrc.json
node
Node.js global variables and Node.js scoping
{"type": "boolean"}
eslintrc.json
phantomjs
PhantomJS global variables
{"type": "boolean"}
eslintrc.json
prototypejs
Prototype.js global variables
{"type": "boolean"}
eslintrc.json
protractor
Protractor global variables
{"type": "boolean"}
eslintrc.json
qunit
QUnit global variables
{"type": "boolean"}
eslintrc.json
serviceworker
Service Worker global variables
{"type": "boolean"}
eslintrc.json
shelljs
ShellJS global variables
{"type": "boolean"}
eslintrc.json
webextensions
WebExtensions globals
{"type": "boolean"}
eslintrc.json
worker
web workers global variables
{"type": "boolean"}
eslintrc.json
extends
If you want to extend a specific configuration file, you can use the extends property and specify the path to the file. The path can be either relative or absolute.
{}
eslintrc.json
globals
Set each global variable name equal to true to allow the variable to be overwritten or false to disallow overwriting.
{"type": "object", "additionalProperties": {"oneOf": [{"type": "string", "enum": ["readonly", "writable", "off"]}, {"type": "boolean"}]}}
eslintrc.json
additionalProperties
The values false|"readable" and true|"writeable" are deprecated, they are equivalent to "readonly" and "writable", respectively.
{"type": "boolean"}
eslintrc.json
noInlineConfig
Prevent comments from changing config or rules
{"type": "boolean"}
eslintrc.json
parserOptions
The JavaScript language options to be supported
{"type": "object", "properties": {"ecmaFeatures": {}, "ecmaVersion": {"enum": [3, 5, 6, 2015, 7, 2016, 8, 2017, 9, 2018, 10, 2019, 11, 2020, 12, 2021, 13, 2022, 14, 2023, "latest"], "default": 11}, "sourceType": {"enum": ["script", "module"], "default": "script"}}}
eslintrc.json
ecmaVersion
Set to 3, 5, 6, 7, 8, 9, 10, 11 (default), 12, 13, 14 or "latest" to specify the version of ECMAScript syntax you want to use. You can also set to 2015 (same as 6), 2016 (same as 7), 2017 (same as 8), 2018 (same as 9), 2019 (same as 10), 2020 (same as 11), 2021 (same as 12), 2022 (same as 13) or 2023 (same as 14) to use the year-based naming. "latest" always enables the latest supported ECMAScript version.
{"enum": [3, 5, 6, 2015, 7, 2016, 8, 2017, 9, 2018, 10, 2019, 11, 2020, 12, 2021, 13, 2022, 14, 2023, "latest"], "default": 11}
eslintrc.json
sourceType
set to "script" (default) or "module" if your code is in ECMAScript modules
{"enum": ["script", "module"], "default": "script"}
eslintrc.json
plugins
ESLint supports the use of third-party plugins. Before using the plugin, you have to install it using npm.
{"type": "array", "items": {"type": "string"}}
eslintrc.json
root
By default, ESLint will look for configuration files in all parent folders up to the root directory. This can be useful if you want all of your projects to follow a certain convention, but can sometimes lead to unexpected results. To limit ESLint to a specific project, set this to `true` in a configuration in the root of your project.
{"type": "boolean"}
eslintrc.json
ignorePatterns
Tell ESLint to ignore specific files and directories. Each value uses the same pattern as the `.eslintignore` file.
{}
eslintrc.json
rules
ESLint comes with a large number of rules. You can modify which rules your project uses either using configuration comments or configuration files.
{"type": "object", "allOf": [{}, {}, {}, {}, {}, {}, {}, {}]}
eslintrc.json
settings
ESLint supports adding shared settings into configuration file. You can add settings object to ESLint configuration file and it will be supplied to every rule that will be executed. This may be useful if you are adding custom rules and want them to have access to the same information and be easily configurable.
{"type": "object"}
eslintrc.json
overrides
Allows to override configuration for files and folders, specified by glob patterns
{"type": "array", "items": {"type": "object", "properties": {"files": {"oneOf": [{"type": "string"}, {"minItems": 1, "type": "array", "items": {"type": "string"}}]}, "extends": {}, "excludedFiles": {}, "ecmaFeatures": {}, "env": {}, "globals": {}, "parser": {}, "parserOptions": {}, "plugins": {}, "processor": {"type": "string"}, "rules": {}, "settings": {}, "overrides": {}}, "additionalProperties": false, "required": ["files"]}}
eslintrc.json
files
Glob pattern for files to apply 'overrides' configuration, relative to the directory of the config file
{"oneOf": [{"type": "string"}, {"minItems": 1, "type": "array", "items": {"type": "string"}}]}
eslintrc.json
extends
If you want to extend a specific configuration file, you can use the extends property and specify the path to the file. The path can be either relative or absolute.
{}
eslintrc.json
excludedFiles
If a file matches any of the 'excludedFiles' glob patterns, the 'overrides' configuration won't apply
{}
eslintrc.json
processor
To specify a processor, specify the plugin name and processor name joined by a forward slash
{"type": "string"}
sourcemap-v3.json
^x_
Any property starting with 'x_' is valid.
{"additionalProperties": true}
sourcemap-v3.json
version
File version (always the first entry in the object) and must be a positive integer.
{"type": "integer", "default": 3}
sourcemap-v3.json
file
An optional name of the generated code that this source map is associated with.
{"type": "string"}
sourcemap-v3.json
sourceRoot
An optional source root, useful for relocating source files on a server or removing repeated values in the 'sources' entry. This value is prepended to the individual entries in the 'source' field.
{"type": "string"}
sourcemap-v3.json
sources
A list of original sources used by the 'mappings' entry.
{"type": "array", "items": {"type": "string"}}
sourcemap-v3.json
sourcesContent
An optional list of source content, useful when the 'source' can�t be hosted. The contents are listed in the same order as the sources in line 5. 'null' may be used if some original sources should be retrieved by name.
{"type": "array", "items": {"type": ["string", "null"]}}
sourcemap-v3.json
names
A list of symbol names used by the 'mappings' entry.
{"type": "array", "items": {"type": "string"}}
sourcemap-v3.json
mappings
A string with the encoded mapping data.
{"type": "string"}
sarif-2.1.0-rtm.3.json
Static Analysis Results Format (SARIF) Version 2.1.0-rtm.3 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"}, "kind": {"type": "string"}, "name": {"type": "string"}, "fullyQualifiedName": {"type": "string"}, "offsetFromParent": {"type": "integer"}, "index": {"type": "integer", "default": -1, "minimum": -1}, "parentIndex": {"type": "integer", "default": -1, "minimum": -1}, "properties": {}}}, "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, "default": [], "items": {"enum": ["analysisTarget", "attachment", "responseFile", "resultFile", "standardStream", "tracedFile", "unmodified", "modified", "added", "deleted", "renamed", "uncontrolled", "driver", "extension", "translation", "taxonomy", "policy", "referencedOnCommandLine", "memoryContents", "directory", "userSpecifiedConfiguration", "toolSpecifiedConfiguration", "debugOutputFile"]}}, "mimeType": {"type": "string", "pattern": "[^/]+/.+"}, "contents": {}, "encoding": {"type": "string"}, "sourceLanguage": {"type": "string"}, "hashes": {"type": "object", "additionalProperties": {"type": "string"}}, "lastModifiedTimeUtc": {"type": "string", "format": "date-time"}, "properties": {}}}, "artifactChange": {"additionalProperties": false, "type": "object", "properties": {"artifactLocation": {}, "replacements": {"type": "array", "minItems": 1, "uniqueItems": false, "items": {}}, "properties": {}}, "required": ["artifactLocation", "replacements"]}, "artifactContent": {"type": "object", "additionalProperties": false, "properties": {"text": {"type": "string"}, "binary": {"type": "string"}, "rendered": {}, "properties": {}}}, "artifactLocation": {"additionalProperties": false, "type": "object", "properties": {"uri": {"type": "string", "format": "uri-reference"}, "uriBaseId": {"type": "string"}, "index": {"type": "integer", "default": -1, "minimum": -1}, "properties": {}}}, "attachment": {"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"]}, "codeFlow": {"additionalProperties": false, "type": "object", "properties": {"message": {}, "threadFlows": {"type": "array", "minItems": 1, "uniqueItems": false, "items": {}}, "properties": {}}, "required": ["threadFlows"]}, "configurationOverride": {"type": "object", "additionalProperties": false, "properties": {"configuration": {}, "descriptor": {}, "properties": {}}, "required": ["configuration", "descriptor"]}, "conversion": {"additionalProperties": false, "type": "object", "properties": {"tool": {}, "invocation": {}, "analysisToolLogFiles": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}, "required": ["tool"]}, "edge": {"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "label": {}, "sourceNodeId": {"type": "string"}, "targetNodeId": {"type": "string"}, "properties": {}}, "required": ["id", "sourceNodeId", "targetNodeId"]}, "edgeTraversal": {"type": "object", "additionalProperties": false, "properties": {"edgeId": {"type": "string"}, "message": {}, "finalState": {"type": "object", "additionalProperties": {}}, "stepOverEdgeCount": {"type": "integer", "minimum": 0}, "properties": {}}, "required": ["edgeId"]}, "exception": {"type": "object", "properties": {"kind": {"type": "string"}, "message": {"type": "string"}, "stack": {}, "innerExceptions": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "properties": {}}}, "externalProperties": {"type": "object", "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": "^[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}$"}, "conversion": {}, "graphs": {"type": "array", "minItems": 0, "default": [], "uniqueItems": true, "items": {}}, "externalizedProperties": {}, "artifacts": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}, "invocations": {"type": "array", "minItems": 0, "uniqueItems": false, "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": false, "default": [], "items": {}}, "taxonomies": {"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": {}}, "addresses": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "webRequests": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "webResponses": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}}, "externalPropertyFileReference": {"type": "object", "properties": {"location": {}, "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}$"}, "itemCount": {"type": "integer", "default": -1, "minimum": -1}, "properties": {}}, "anyOf": [{"required": ["location"]}, {"required": ["guid"]}]}, "externalPropertyFileReferences": {"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": {}}}, "fix": {"additionalProperties": false, "type": "object", "properties": {"artifactChanges": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "properties": {}}, "required": ["artifactChanges"]}, "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": {}}}, "graphTraversal": {"type": "object", "additionalProperties": false, "properties": {"runGraphIndex": {"type": "integer", "default": -1, "minimum": -1}, "resultGraphIndex": {"type": "integer", "default": -1, "minimum": -1}, "initialState": {"type": "object", "additionalProperties": {}}, "immutableState": {"type": "object", "additionalProperties": {}}, "edgeTraversals": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "properties": {}}, "oneOf": [{"required": ["runGraphIndex"]}, {"required": ["resultGraphIndex"]}]}, "invocation": {"additionalProperties": false, "type": "object", "properties": {"commandLine": {"type": "string"}, "arguments": {"type": "array", "minItems": 0, "uniqueItems": false, "items": {"type": "string"}}, "responseFiles": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}, "startTimeUtc": {"type": "string", "format": "date-time"}, "endTimeUtc": {"type": "string", "format": "date-time"}, "exitCode": {"type": "integer"}, "ruleConfigurationOverrides": {"type": "array", "minItems": 0, "default": [], "uniqueItems": true, "items": {}}, "notificationConfigurationOverrides": {"type": "array", "minItems": 0, "default": [], "uniqueItems": true, "items": {}}, "toolExecutionNotifications": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "toolConfigurationNotifications": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "exitCodeDescription": {"type": "string"}, "exitSignalName": {"type": "string"}, "exitSignalNumber": {"type": "integer"}, "processStartFailureMessage": {"type": "string"}, "executionSuccessful": {"type": "boolean"}, "machine": {"type": "string"}, "account": {"type": "string"}, "processId": {"type": "integer"}, "executableLocation": {}, "workingDirectory": {}, "environmentVariables": {"type": "object", "additionalProperties": {"type": "string"}}, "stdin": {}, "stdout": {}, "stderr": {}, "stdoutStderr": {}, "properties": {}}, "required": ["executionSuccessful"]}, "location": {"additionalProperties": false, "type": "object", "properties": {"id": {"type": "integer", "minimum": -1, "default": -1}, "physicalLocation": {}, "logicalLocations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "message": {}, "annotations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "relationships": {"type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": {}}, "properties": {}}}, "locationRelationship": {"type": "object", "additionalProperties": false, "properties": {"target": {"type": "integer", "minimum": 0}, "kinds": {"type": "array", "default": ["relevant"], "uniqueItems": true, "items": {"type": "string"}}, "properties": {}}, "required": ["target"]}, "logicalLocation": {"additionalProperties": false, "type": "object", "properties": {"name": {"type": "string"}, "index": {"type": "integer", "default": -1, "minimum": -1}, "fullyQualifiedName": {"type": "string"}, "decoratedName": {"type": "string"}, "parentIndex": {"type": "integer", "default": -1, "minimum": -1}, "kind": {"type": "string"}, "properties": {}}}, "message": {"type": "object", "additionalProperties": false, "properties": {"text": {"type": "string"}, "markdown": {"type": "string"}, "id": {"type": "string"}, "arguments": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {"type": "string"}}, "properties": {}}, "anyOf": [{"required": ["text"]}, {"required": ["id"]}]}, "multiformatMessageString": {"type": "object", "additionalProperties": false, "properties": {"text": {"type": "string"}, "markdown": {"type": "string"}, "properties": {}}, "required": ["text"]}, "node": {"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "label": {}, "location": {}, "children": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}, "required": ["id"]}, "notification": {"type": "object", "additionalProperties": false, "properties": {"locations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "message": {}, "level": {"default": "warning", "enum": ["none", "note", "warning", "error"]}, "threadId": {"type": "integer"}, "timeUtc": {"type": "string", "format": "date-time"}, "exception": {}, "descriptor": {}, "associatedRule": {}, "properties": {}}, "required": ["message"]}, "physicalLocation": {"additionalProperties": false, "type": "object", "properties": {"address": {}, "artifactLocation": {}, "region": {}, "contextRegion": {}, "properties": {}}, "anyOf": [{"required": ["address"]}, {"required": ["artifactLocation"]}]}, "propertyBag": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {"type": "string"}}}}, "rectangle": {"additionalProperties": false, "type": "object", "properties": {"top": {"type": "number"}, "left": {"type": "number"}, "bottom": {"type": "number"}, "right": {"type": "number"}, "message": {}, "properties": {}}}, "region": {"additionalProperties": false, "type": "object", "properties": {"startLine": {"type": "integer", "minimum": 1}, "startColumn": {"type": "integer", "minimum": 1}, "endLine": {"type": "integer", "minimum": 1}, "endColumn": {"type": "integer", "minimum": 1}, "charOffset": {"type": "integer", "default": -1, "minimum": -1}, "charLength": {"type": "integer", "minimum": 0}, "byteOffset": {"type": "integer", "default": -1, "minimum": -1}, "byteLength": {"type": "integer", "minimum": 0}, "snippet": {}, "message": {}, "sourceLanguage": {"type": "string"}, "properties": {}}}, "replacement": {"additionalProperties": false, "type": "object", "properties": {"deletedRegion": {}, "insertedContent": {}, "properties": {}}, "required": ["deletedRegion"]}, "reportingDescriptor": {"additionalProperties": false, "type": "object", "properties": {"id": {"type": "string"}, "deprecatedIds": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {"type": "string"}}, "guid": {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"}, "deprecatedGuids": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"}}, "name": {"type": "string"}, "deprecatedNames": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {"type": "string"}}, "shortDescription": {}, "fullDescription": {}, "messageStrings": {"type": "object", "additionalProperties": {}}, "defaultConfiguration": {}, "helpUri": {"type": "string", "format": "uri"}, "help": {}, "relationships": {"type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": {}}, "properties": {}}, "required": ["id"]}, "reportingConfiguration": {"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean", "default": true}, "level": {"default": "warning", "enum": ["none", "note", "warning", "error"]}, "rank": {"type": "number", "default": -1, "minimum": -1, "maximum": 100}, "parameters": {}, "properties": {}}}, "reportingDescriptorReference": {"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "index": {"type": "integer", "default": -1, "minimum": -1}, "guid": {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"}, "toolComponent": {}, "properties": {}}, "anyOf": [{"required": ["index"]}, {"required": ["guid"]}, {"required": ["id"]}]}, "reportingDescriptorRelationship": {"type": "object", "additionalProperties": false, "properties": {"target": {}, "kinds": {"type": "array", "default": ["relevant"], "uniqueItems": true, "items": {"type": "string"}}, "properties": {}}, "required": ["target"]}, "result": {"additionalProperties": false, "type": "object", "properties": {"ruleId": {"type": "string"}, "ruleIndex": {"type": "integer", "default": -1, "minimum": -1}, "rule": {}, "kind": {"default": "fail", "enum": ["notApplicable", "pass", "fail", "review", "open", "informational"]}, "level": {"default": "warning", "enum": ["none", "note", "warning", "error"]}, "message": {}, "analysisTarget": {}, "locations": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "guid": {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"}, "correlationGuid": {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"}, "occurrenceCount": {"type": "integer", "minimum": 1}, "partialFingerprints": {"type": "object", "additionalProperties": {"type": "string"}}, "fingerprints": {"type": "object", "additionalProperties": {"type": "string"}}, "stacks": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "codeFlows": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "graphs": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "graphTraversals": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "relatedLocations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "suppressions": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}, "baselineState": {"enum": ["new", "unchanged", "updated", "absent"]}, "rank": {"type": "number", "default": -1, "minimum": -1, "maximum": 100}, "attachments": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "hostedViewerUri": {"type": "string", "format": "uri"}, "workItemUris": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {"type": "string", "format": "uri"}}, "provenance": {}, "fixes": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "taxa": {"type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": {}}, "webRequest": {}, "webResponse": {}, "properties": {}}, "required": ["message"]}, "resultProvenance": {"additionalProperties": false, "type": "object", "properties": {"firstDetectionTimeUtc": {"type": "string", "format": "date-time"}, "lastDetectionTimeUtc": {"type": "string", "format": "date-time"}, "firstDetectionRunGuid": {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"}, "lastDetectionRunGuid": {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"}, "invocationIndex": {"type": "integer", "default": -1, "minimum": -1}, "conversionSources": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}}, "run": {"additionalProperties": false, "type": "object", "properties": {"tool": {}, "invocations": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "conversion": {}, "language": {"type": "string", "default": "en-US", "pattern": "^[a-zA-Z]{2}|^[a-zA-Z]{2}-[a-zA-Z]{2}?$"}, "versionControlProvenance": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "originalUriBaseIds": {"type": "object", "additionalProperties": {}}, "artifacts": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}, "logicalLocations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "graphs": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "results": {"type": "array", "minItems": 0, "uniqueItems": false, "items": {}}, "automationDetails": {}, "runAggregates": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "baselineGuid": {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"}, "redactionTokens": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {"type": "string"}}, "defaultEncoding": {"type": "string"}, "defaultSourceLanguage": {"type": "string"}, "newlineSequences": {"type": "array", "minItems": 1, "uniqueItems": true, "default": ["\r\n", "\n"], "items": {"type": "string"}}, "columnKind": {"enum": ["utf16CodeUnits", "unicodeCodePoints"]}, "externalPropertyFileReferences": {}, "threadFlowLocations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "taxonomies": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "addresses": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "translations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "policies": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "webRequests": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "webResponses": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "specialLocations": {}, "properties": {}}, "required": ["tool"]}, "runAutomationDetails": {"additionalProperties": false, "type": "object", "properties": {"id": {"type": "string"}, "guid": {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"}, "correlationGuid": {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"}, "properties": {}}}, "specialLocations": {"type": "object", "properties": {"displayBase": {}, "properties": {}}}, "stack": {"additionalProperties": false, "type": "object", "properties": {"message": {}, "frames": {"type": "array", "minItems": 0, "uniqueItems": false, "items": {}}, "properties": {}}, "required": ["frames"]}, "stackFrame": {"additionalProperties": false, "type": "object", "properties": {"location": {}, "module": {"type": "string"}, "threadId": {"type": "integer"}, "parameters": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {"type": "string", "default": []}}, "properties": {}}}, "suppression": {"additionalProperties": false, "type": "object", "properties": {"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}$"}, "kind": {"enum": ["inSource", "external"]}, "state": {"enum": ["accepted", "underReview", "rejected"]}, "justification": {"type": "string"}, "location": {}, "properties": {}}, "required": ["kind"]}, "threadFlow": {"type": "object", "properties": {"id": {"type": "string"}, "message": {}, "initialState": {"type": "object", "additionalProperties": {}}, "immutableState": {"type": "object", "additionalProperties": {}}, "locations": {"type": "array", "minItems": 1, "uniqueItems": false, "items": {}}, "properties": {}}, "required": ["locations"]}, "threadFlowLocation": {"additionalProperties": false, "type": "object", "properties": {"index": {"type": "integer", "default": -1, "minimum": -1}, "location": {}, "stack": {}, "kinds": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {"type": "string"}}, "taxa": {"type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": {}}, "module": {"type": "string"}, "state": {"type": "object", "additionalProperties": {}}, "nestingLevel": {"type": "integer", "minimum": 0}, "executionOrder": {"type": "integer", "default": -1, "minimum": -1}, "executionTimeUtc": {"type": "string", "format": "date-time"}, "importance": {"enum": ["important", "essential", "unimportant"], "default": "important"}, "webRequest": {}, "webResponse": {}, "properties": {}}}, "tool": {"additionalProperties": false, "type": "object", "properties": {"driver": {}, "extensions": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}, "required": ["driver"]}, "toolComponent": {"additionalProperties": false, "type": "object", "properties": {"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}$"}, "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}-[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"]}, "toolComponentReference": {"type": "object", "properties": {"name": {"type": "string"}, "index": {"type": "integer", "default": -1, "minimum": -1}, "guid": {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"}, "properties": {}}}, "translationMetadata": {"type": "object", "properties": {"name": {"type": "string"}, "fullName": {"type": "string"}, "shortDescription": {}, "fullDescription": {}, "downloadUri": {"type": "string", "format": "uri"}, "informationUri": {"type": "string", "format": "uri"}, "properties": {}}, "required": ["name"]}, "versionControlDetails": {"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"]}, "webRequest": {"type": "object", "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": {}}}, "webResponse": {"type": "object", "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": {}}}}, "properties": {"$schema": {"type": "string", "format": "uri"}, "version": {"enum": ["2.1.0"]}, "runs": {"type": "array", "minItems": 0, "uniqueItems": false, "items": {}}, "inlineExternalProperties": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}, "properties": {}}, "required": ["version", "runs"], "type": "object"}
sarif-2.1.0-rtm.3.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"}, "offsetFromParent": {"type": "integer"}, "index": {"type": "integer", "default": -1, "minimum": -1}, "parentIndex": {"type": "integer", "default": -1, "minimum": -1}, "properties": {}}}
sarif-2.1.0-rtm.3.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-rtm.3.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-rtm.3.json
length
The number of bytes in this range of addresses.
{"type": "integer"}
sarif-2.1.0-rtm.3.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-rtm.3.json
name
A name that is associated with the address, e.g., '.text'.
{"type": "string"}
sarif-2.1.0-rtm.3.json
fullyQualifiedName
A human-readable fully qualified name that is associated with the address.
{"type": "string"}
sarif-2.1.0-rtm.3.json
offsetFromParent
The byte offset of this address from the absolute or relative address of the parent object.
{"type": "integer"}
sarif-2.1.0-rtm.3.json
index
The index within run.addresses of the cached object for this address.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0-rtm.3.json
parentIndex
The index within run.addresses of the parent object.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0-rtm.3.json
properties
Key/value pairs that provide additional information about the address.
{}
sarif-2.1.0-rtm.3.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, "default": [], "items": {"enum": ["analysisTarget", "attachment", "responseFile", "resultFile", "standardStream", "tracedFile", "unmodified", "modified", "added", "deleted", "renamed", "uncontrolled", "driver", "extension", "translation", "taxonomy", "policy", "referencedOnCommandLine", "memoryContents", "directory", "userSpecifiedConfiguration", "toolSpecifiedConfiguration", "debugOutputFile"]}}, "mimeType": {"type": "string", "pattern": "[^/]+/.+"}, "contents": {}, "encoding": {"type": "string"}, "sourceLanguage": {"type": "string"}, "hashes": {"type": "object", "additionalProperties": {"type": "string"}}, "lastModifiedTimeUtc": {"type": "string", "format": "date-time"}, "properties": {}}}
sarif-2.1.0-rtm.3.json
description
A short description of the artifact.
{}
sarif-2.1.0-rtm.3.json
location
The location of the artifact.
{}
sarif-2.1.0-rtm.3.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-rtm.3.json
offset
The offset in bytes of the artifact within its containing artifact.
{"type": "integer", "minimum": 0}
sarif-2.1.0-rtm.3.json
length
The length of the artifact in bytes.
{"type": "integer", "default": -1, "minimum": -1}
sarif-2.1.0-rtm.3.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", "referencedOnCommandLine", "memoryContents", "directory", "userSpecifiedConfiguration", "toolSpecifiedConfiguration", "debugOutputFile"]}}
sarif-2.1.0-rtm.3.json
mimeType
The MIME type (RFC 2045) of the artifact.
{"type": "string", "pattern": "[^/]+/.+"}
sarif-2.1.0-rtm.3.json
contents
The contents of the artifact.
{}
sarif-2.1.0-rtm.3.json
encoding
Specifies the encoding for an artifact object that refers to a text file.
{"type": "string"}
sarif-2.1.0-rtm.3.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-rtm.3.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-rtm.3.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-rtm.3.json
properties
Key/value pairs that provide additional information about the artifact.
{}