schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
coffeelint.json
no_empty_param_list
This rule prohibits empty parameter lists in function definitions. [default level: ignore]
{"allOf": [{}]}
coffeelint.json
no_implicit_braces
This rule prohibits implicit braces when declaring object literals. Implicit braces can make code more difficult to understand, especially when used in combination with optional parenthesis. [default level: ignore]
{"allOf": [{}], "properties": {"strict": {"type": "boolean"}}}
coffeelint.json
no_implicit_parens
This rule prohibits implicit parens on function calls. [default level: ignore]
{"allOf": [{}]}
coffeelint.json
no_interpolation_in_single_quotes
This rule prohibits string interpolation in a single quoted string. [default level: ignore]
{"allOf": [{}]}
coffeelint.json
no_nested_string_interpolation
This rule warns about nested string interpolation, as it tends to make code harder to read and understand. [default level: warn]
{"allOf": [{}]}
coffeelint.json
no_plusplus
This rule forbids the increment and decrement arithmetic operators. Some people believe the `++` and `--` to be cryptic and the cause of bugs due to misunderstandings of their precedence rules. [default level: ignore]
{"allOf": [{}]}
coffeelint.json
no_private_function_fat_arrows
Warns when you use the fat arrow for a private function inside a class definition scope. It is not necessary and it does not do anything. [default level: warn]
{"allOf": [{}]}
coffeelint.json
no_stand_alone_at
This rule checks that no stand alone `@` are in use, they are discouraged. [default level: ignore]
{"type": "object", "allOf": [{}]}
coffeelint.json
no_tabs
This rule forbids tabs in indentation. Enough said. [default level: error]
{"type": "object", "allOf": [{}]}
coffeelint.json
no_this
This rule prohibits `this`. Use `@` instead. [default level: ignore]
{"allOf": [{}]}
coffeelint.json
no_throwing_strings
This rule forbids throwing string literals or interpolations. While JavaScript (and CoffeeScript by extension) allow any expression to be thrown, it is best to only throw `Error` objects, because they contain valuable debugging information like the stack trace. [default level: error]
{"allOf": [{}]}
coffeelint.json
no_trailing_semicolons
This rule prohibits trailing semicolons, since they are needless cruft in CoffeeScript. [default level: error]
{"allOf": [{}]}
coffeelint.json
no_trailing_whitespace
This rule forbids trailing whitespace in your code, since it is needless cruft. [default level: error]
{"allOf": [{}], "properties": {"allowed_in_comments": {"type": "boolean"}, "allowed_in_empty_lines": {"type": "boolean"}}}
coffeelint.json
no_unnecessary_double_quotes
This rule prohibits double quotes unless string interpolation is used or the string contains single quotes. [default level: ignore]
{"allOf": [{}]}
coffeelint.json
no_unnecessary_fat_arrows
Disallows defining functions with fat arrows when `this` is not used within the function. [default level: warn]
{"allOf": [{}]}
coffeelint.json
non_empty_constructor_needs_parens
Requires constructors with parameters to include the parens. [default level: ignore]
{"allOf": [{}]}
coffeelint.json
prefer_english_operator
This rule prohibits `&&`, `||`, `==`, `!=` and `!`. Use `and`, `or`, `is`, `isnt`, and `not` instead. `!!` (for converting to a boolean) is ignored. [default level: ignore]
{"allOf": [{}]}
coffeelint.json
space_operators
This rule enforces that operators have space around them. [default level: ignore]
{"allOf": [{}]}
coffeelint.json
spacing_after_comma
This rule checks to make sure you have a space after commas. [default level: ignore]
{"allOf": [{}]}
coffeelint.json
transform_messes_up_line_numbers
This rule detects when changes are made by transform function, and warns that line numbers are probably incorrect. [default level: warn]
{"allOf": [{}]}
chart.json
apiVersion
The apiVersion field should be v2 for Helm charts that require at least Helm 3. Charts supporting previous Helm versions have an apiVersion set to v1 and are still installable by Helm 3.
{"enum": ["v1", "v2"]}
chart.json
name
The name of the chart
{"type": "string"}
chart.json
version
A SemVer 2 version
{"type": "string"}
chart.json
kubeVersion
The optional kubeVersion field can define semver constraints on supported Kubernetes versions. Helm will validate the version constraints when installing the chart and fail if the cluster runs an unsupported Kubernetes version.
{"type": "string"}
chart.json
description
A single-sentence description of this project
{"type": "string"}
chart.json
type
The type of the chart
{"default": "application", "enum": ["application", "library"]}
chart.json
keywords
A list of keywords about this project
{"type": "array", "items": {"type": "string"}}
chart.json
home
The URL of this projects home page
{"type": "string", "format": "uri"}
chart.json
sources
A list of URLs to source code for this project
{"type": "array", "items": {"type": "string", "format": "uri"}}
chart.json
dependencies
In Helm, one chart may depend on any number of other charts. These dependencies can be dynamically linked using the dependencies field in Chart.yaml or brought in to the charts/ directory and managed manually. The charts required by the current chart are defined as a list in the dependencies field.
{"type": "array", "items": {"type": "object", "additionalProperties": false, "required": ["name"], "properties": {"name": {"type": "string"}, "version": {"type": "string"}, "repository": {"anyOf": [{"type": "string", "format": "uri"}, {"type": "string", "pattern": "^@"}]}, "condition": {"type": "string"}, "tags": {"type": "array", "items": {"type": "string"}}, "import-values": {"type": "array", "items": {"oneOf": [{"type": "string"}, {"type": "object", "additionalProperties": false, "required": ["parent", "child"], "properties": {"parent": {"type": "string"}, "child": {"type": "string"}}}]}}, "alias": {"type": "string"}}}}
chart.json
name
The name of the chart
{"type": "string"}
chart.json
version
The version of the chart
{"type": "string"}
chart.json
repository
The repository URL or alias
{"anyOf": [{"type": "string", "format": "uri"}, {"type": "string", "pattern": "^@"}]}
chart.json
condition
A yaml path that resolves to a boolean, used for enabling/disabling charts
{"type": "string"}
chart.json
tags
Tags can be used to group charts for enabling/disabling together
{"type": "array", "items": {"type": "string"}}
chart.json
import-values
ImportValues holds the mapping of source values to parent key to be imported. Each item can be a string or pair of child/parent sublist items.
{"type": "array", "items": {"oneOf": [{"type": "string"}, {"type": "object", "additionalProperties": false, "required": ["parent", "child"], "properties": {"parent": {"type": "string"}, "child": {"type": "string"}}}]}}
chart.json
parent
The destination path in the parent chart's values
{"type": "string"}
chart.json
child
The source key of the values to be imported
{"type": "string"}
chart.json
alias
Alias to be used for the chart. Useful when you have to add the same chart multiple times
{"type": "string"}
chart.json
name
The maintainers name
{"type": "string"}
chart.json
email
The maintainers email
{"type": "string", "format": "email"}
chart.json
url
A URL for the maintainer
{"type": "string", "format": "uri"}
chart.json
icon
A URL to an SVG or PNG image to be used as an icon
{"type": "string", "format": "uri"}
chart.json
appVersion
Note that the appVersion field is not related to the version field. It is a way of specifying the version of the application. For example, the drupal chart may have an appVersion: "8.2.1", indicating that the version of Drupal included in the chart (by default) is 8.2.1. This field is informational, and has no impact on chart version calculations. Wrapping the version in quotes is highly recommended. It forces the YAML parser to treat the version number as a string. Leaving it unquoted can lead to parsing issues in some cases. For example, YAML interprets 1.0 as a floating point value, and a git commit SHA like 1234e10 as scientific notation.
{"type": "string"}
chart.json
deprecated
When managing charts in a Chart Repository, it is sometimes necessary to deprecate a chart. The optional deprecated field in Chart.yaml can be used to mark a chart as deprecated. If the latest version of a chart in the repository is marked as deprecated, then the chart as a whole is considered to be deprecated. The chart name can be later reused by publishing a newer version that is not marked as deprecated.
{"type": "boolean"}
chart.json
annotations
A list of annotations keyed by name
{"type": "object", "additionalProperties": {"type": "string"}, "properties": {"artifacthub.io/changes": {"type": "string"}, "artifacthub.io/containsSecurityUpdates": {"enum": ["true", "false"]}, "artifacthub.io/crds": {"type": "string"}, "artifacthub.io/images": {"type": "string"}, "artifacthub.io/crdsExamples": {"type": "string"}, "artifacthub.io/license": {"type": "string"}, "artifacthub.io/links": {"type": "string"}, "artifacthub.io/maintainers": {"type": "string"}, "artifacthub.io/operator": {"enum": ["true", "false"]}, "artifacthub.io/operatorCapabilities": {"enum": ["Basic Install", "Seamless Upgrades", "Full Lifecycle", "Deep Insights", "Auto Pilot"]}, "artifacthub.io/prerelease": {"enum": ["true", "false"]}, "artifacthub.io/recommendations": {"type": "string"}, "artifacthub.io/signKey": {"type": "string"}}}
chart.json
artifacthub.io/changes
This annotation is used to provide some details about the changes introduced by a given chart version. Artifact Hub can generate and display a ChangeLog based on the entries in the changes field in all your chart versions. This annotation can be provided using two different formats: using a plain list of strings with the description of the change or using a list of objects with some extra structured information (see example below). Please feel free to use the one that better suits your needs. The UI experience will be slightly different depending on the choice. When using the list of objects option the valid supported kinds are added, changed, deprecated, removed, fixed and security.
{"type": "string"}
chart.json
artifacthub.io/containsSecurityUpdates
Use this annotation to indicate that this chart version contains security updates. When a package release contains security updates, a special message will be displayed in the Artifact Hub UI as well as in the new release email notification.
{"enum": ["true", "false"]}
chart.json
artifacthub.io/crds
By default, Artifact Hub will try to extract the containers images used by Helm charts from the manifests generated from a dry-run install using the default values. If you prefer, you can also provide a list of containers images manually by using this annotation. Containers images will be scanned for security vulnerabilities. The security report generated will be available in the package detail view. It is possible to whitelist images so that they are not scanned by setting the whitelisted flag to true.
{"type": "string"}
chart.json
artifacthub.io/images
This annotation can be used to list the operator's CRDs. They will be visible in the package's detail view as cards.
{"type": "string"}
chart.json
artifacthub.io/crdsExamples
Use this annotation to provide a list of example CRs for the operator's CRDs. Each of the examples can be opened from the corresponding CRD card in the package's detail view.
{"type": "string"}
chart.json
artifacthub.io/license
Use this annotation to indicate the chart's license. By default, Artifact Hub tries to read the chart's license from the LICENSE file in the chart, but it's possible to override or provide it with this annotation. It must be a valid SPDX identifier.
{"type": "string"}
chart.json
artifacthub.io/links
This annotation allows including named links, which will be rendered nicely in Artifact Hub. You can use this annotation to include links not included previously in the Chart.yaml file, or you can use it to name links already present (in the sources section, for example).
{"type": "string"}
chart.json
artifacthub.io/maintainers
This annotation can be used if you want to display a different name for a given user in Artifact Hub than the one used in the Chart.yaml file. If the email used matches, the name used in the annotations entry will be displayed in Artifact Hub. It's also possible to include maintainers that should only be listed in Artifact Hub by adding additional entries.
{"type": "string"}
chart.json
artifacthub.io/operator
Use this annotation to indicate that your chart represents an operator. Artifact Hub at the moment also considers your chart to represent an operator if the word operator appears in the chart name.
{"enum": ["true", "false"]}
chart.json
artifacthub.io/operatorCapabilities
Use this annotation to indicate the capabilities of the operator your chart provides. It must be one of the following options: Basic Install, Seamless Upgrades, Full Lifecycle, Deep Insights or Auto Pilot. For more information please see the capability level diagram.
{"enum": ["Basic Install", "Seamless Upgrades", "Full Lifecycle", "Deep Insights", "Auto Pilot"]}
chart.json
artifacthub.io/prerelease
Use this annotation to indicate that this chart version is a pre-release. This status will be displayed in the UI's package view, as well as in new releases notifications emails.
{"enum": ["true", "false"]}
chart.json
artifacthub.io/recommendations
This annotation allows recommending other related packages. Recommended packages will be featured in the package detail view in Artifact Hub.
{"type": "string"}
chart.json
artifacthub.io/signKey
This annotation can be used to provide some information about the key used to sign a given chart version. This information will be displayed on the Artifact Hub UI, making it easier for users to get the information they need to verify the integrity and origin of your chart. The url field indicates where users can find the public key and it is mandatory when a sign key entry is provided.
{"type": "string"}
jscpd.json
minLines
minimum size of code block in lines to check for duplication
{"type": "integer", "default": 5}
jscpd.json
maxLines
maximum size of source file in lines to check for duplication
{"type": "integer", "default": 1000}
jscpd.json
maxSize
maximum size of source file in bytes to check for duplication (e.g.,: 1kb, 1mb, 120kb)
{"anyOf": [{"type": "string", "pattern": "^\\+?[0-9]+(\\.[0-9]+)? *[kKmMgGtTpP][bB]$"}, {"type": "integer"}], "default": "100kb"}
jscpd.json
minTokens
minimum size of code block in tokens to check for duplication
{"type": "integer", "default": 50}
jscpd.json
threshold
maximum allowed duplicate lines expressed as a percentage; exit with error and exit code 1 when threshold exceeded
{"type": "number"}
jscpd.json
formatsExts
custom mapping from formats to file extensions (default: https://github.com/kucherenko/jscpd/blob/master/packages/tokenizer/src/formats.ts); see https://github.com/kucherenko/jscpd/blob/master/supported_formats.md
{"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}, "default": {}}
jscpd.json
output
path to directory for non-console reports
{"type": "string", "default": "./report"}
jscpd.json
path
paths that should be included in duplicate detection (default: [process.cwd()])
{"type": "array", "items": {"type": "string"}}
jscpd.json
pattern
glob pattern for files that should be included in duplicate detection (e.g., **/*.txt); only used to filter directories configured via path option
{"type": "string", "default": "**/*"}
jscpd.json
ignorePattern
ignore code blocks matching these regular expressions
{"type": "array", "items": {"type": "string"}, "default": []}
jscpd.json
mode
mode of detection quality; see https://github.com/kucherenko/jscpd/blob/master/packages/jscpd/README.md#mode
{"enum": ["mild", "strict", "weak"], "default": "mild"}
jscpd.json
ignore
glob pattern for files that should be excluded from duplicate detection
{"type": "array", "items": {"type": "string"}, "default": []}
jscpd.json
format
list of formats for which to detect duplication (default: all); see https://github.com/kucherenko/jscpd/blob/master/supported_formats.md
{"type": "array", "items": {}}
jscpd.json
store
store used to collect information about code (default: in-memory store); install @jscpd/leveldb-store and use leveldb for big repositories
{"enum": ["leveldb", "redis"]}
jscpd.json
reporters
a list of reporters to use to output information about duplication; see https://github.com/kucherenko/jscpd/blob/master/packages/jscpd/README.md#reporters
{"type": "array", "items": {"enum": ["xml", "json", "csv", "markdown", "consoleFull", "html", "console", "silent", "threshold", "xcode"]}, "default": ["console"]}
jscpd.json
blame
get information about authors and dates of duplicated blocks from Git
{"type": "boolean", "default": false}
jscpd.json
silent
do not write duplicate detection progress and result to console
{"type": "boolean", "default": false}
jscpd.json
verbose
show full information during duplicate detection
{"type": "boolean", "default": false}
jscpd.json
absolute
use absolute paths in reports
{"type": "boolean", "default": false}
jscpd.json
noSymLinks
do not follow symlinks
{"type": "boolean", "default": false}
jscpd.json
skipLocal
skip duplicates within folders; just detect cross-folder duplicates
{"type": "boolean", "default": false}
jscpd.json
ignoreCase
ignore case of symbols in code (experimental)
{"type": "boolean", "default": false}
jscpd.json
gitignore
ignore all files from .gitignore file
{"type": "boolean", "default": false}
jscpd.json
path
output path for duplication level badge (default: path.join(output, 'jscpd-badge.svg'))
{"type": "string"}
jscpd.json
label
badge subject text (URL-encoding needed for spaces or special characters)
{"type": "string", "default": "Copy/Paste"}
jscpd.json
labelColor
badge label color (name or RGB code without #); see https://github.com/badgen/badgen/blob/master/src/color-presets.ts
{"default": "555"}
jscpd.json
status
badge value text (URL-encoding needed for spaces or special characters, default: duplication %)
{"type": "string"}
jscpd.json
color
badge color (name or RGB code without #, default: green if beneath threshold, red if above threshold, grey if threshold not set); see https://github.com/badgen/badgen/blob/master/src/color-presets.ts
{}
jscpd.json
style
badge look: flat or classic
{"enum": ["flat", "classic"], "default": "classic"}
jscpd.json
icon
URL for icon to display in front of badge subject text (e.g., data:image/svg+xml;base64,...)
{"type": "string"}
jscpd.json
iconWidth
SVG width of icon to display in front of badge subject text; set this if icon is not square
{"type": "number", "default": 13}
jscpd.json
scale
size of badge relative to default of 1
{"type": "number", "default": 1}
jscpd.json
exitCode
exit code to use when at least one duplicate code block is detected but threshold is not exceeded
{"type": "integer", "default": 0}
sarif-1.0.0.json
Static Analysis Results Format (SARIF) Version 1.0.0 JSON Schema: a standard format for the output of static analysis and other tools.
{"$schema": "http://json-schema.org/draft-04/schema#", "additionalProperties": false, "definitions": {"annotatedCodeLocation": {"additionalProperties": false, "type": "object", "properties": {"id": {"type": ["integer", "string"], "pattern": "^[1-9][0-9]*$", "minimum": 1}, "step": {"type": "integer", "minimum": 0}, "physicalLocation": {}, "fullyQualifiedLogicalName": {"type": "string"}, "logicalLocationKey": {"type": "string"}, "module": {"type": "string"}, "threadId": {"type": "integer"}, "message": {"type": "string"}, "kind": {"enum": ["alias", "assignment", "branch", "call", "callReturn", "continuation", "declaration", "functionEnter", "functionExit", "functionReturn", "usage"]}, "taintKind": {"enum": ["source", "sink", "sanitizer"]}, "target": {"type": "string"}, "values": {"type": "array", "default": [], "items": {"type": "string"}}, "state": {"type": "object"}, "targetKey": {"type": "string"}, "essential": {"type": "boolean"}, "importance": {"enum": ["important", "essential", "unimportant"]}, "snippet": {"type": "string"}, "annotations": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}}, "annotation": {"type": "object", "properties": {"message": {"type": "string"}, "locations": {"type": "array", "minItems": 1, "items": {}}}, "required": ["message", "locations"]}, "codeFlow": {"type": "object", "properties": {"message": {"type": "string"}, "locations": {"type": "array", "minItems": 1, "items": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["locations"]}, "exception": {"type": "object", "properties": {"kind": {"type": "string"}, "message": {"type": "string"}, "stack": {}, "innerExceptions": {"type": "array", "items": {}}}}, "fileChange": {"additionalProperties": false, "type": "object", "properties": {"uri": {"type": "string", "format": "uri"}, "uriBaseId": {"type": "string"}, "replacements": {"type": "array", "minItems": 1, "items": {}}}, "required": ["uri", "replacements"], "dependencies": {"uriBaseId": ["uri"]}}, "file": {"additionalProperties": false, "type": "object", "properties": {"uri": {"type": "string", "format": "uri"}, "uriBaseId": {"type": "string"}, "parentKey": {"type": "string"}, "offset": {"type": "integer"}, "length": {"type": "integer"}, "mimeType": {"type": "string", "pattern": "[^/]+/.+"}, "contents": {"type": "string"}, "hashes": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "dependencies": {"uriBaseId": ["uri"]}}, "fix": {"additionalProperties": false, "type": "object", "properties": {"fileChanges": {"type": "array", "items": {}}}, "required": ["description", "fileChanges"]}, "formattedRuleMessage": {"additionalProperties": false, "type": "object", "properties": {"formatId": {"type": "string"}, "arguments": {"type": "array", "items": {"type": "string"}}}, "required": ["formatId"]}, "hash": {"additionalProperties": false, "type": "object", "properties": {"value": {"type": "string"}, "algorithm": {"enum": ["authentihash", "blake256", "blake512", "ecoh", "fsb", "gost", "groestl", "has160", "haval", "jh", "md2", "md4", "md5", "md6", "radioGatun", "ripeMD", "ripeMD128", "ripeMD160", "ripeMD320", "sdhash", "sha1", "sha224", "sha256", "sha384", "sha512", "sha3", "skein", "snefru", "spectralHash", "ssdeep", "swifft", "tiger", "tlsh", "whirlpool"]}}, "required": ["value", "algorithm"]}, "invocation": {"additionalProperties": false, "type": "object", "properties": {"commandLine": {"type": "string"}, "responseFiles": {"type": "object", "additionalProperties": true}, "startTime": {"type": "string", "format": "date-time"}, "endTime": {"type": "string", "format": "date-time"}, "machine": {"type": "string"}, "account": {"type": "string"}, "processId": {"type": "integer"}, "fileName": {"type": "string"}, "workingDirectory": {"type": "string"}, "environmentVariables": {"type": "object", "additionalProperties": true, "default": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}}, "location": {"additionalProperties": false, "type": "object", "properties": {"analysisTarget": {}, "resultFile": {}, "fullyQualifiedLogicalName": {"type": "string"}, "logicalLocationKey": {"type": "string"}, "decoratedName": {"type": "string"}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}}, "logicalLocation": {"additionalProperties": false, "type": "object", "properties": {"name": {"type": "string"}, "parentKey": {"type": "string"}, "kind": {"type": "string"}}}, "notification": {"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "ruleId": {"type": "string"}, "ruleKey": {"type": "string"}, "physicalLocation": {}, "message": {"type": "string"}, "level": {"default": "warning", "enum": ["note", "warning", "error"]}, "threadId": {"type": "integer"}, "time": {"type": "string", "format": "date-time"}, "exception": {}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["message"]}, "physicalLocation": {"additionalProperties": false, "type": "object", "properties": {"uri": {"type": "string", "format": "uri"}, "uriBaseId": {"type": "string"}, "region": {}}, "dependencies": {"uriBaseId": ["uri"]}}, "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}, "offset": {"type": "integer", "minimum": 0}, "length": {"type": "integer", "minimum": 0}}}, "replacement": {"additionalProperties": false, "type": "object", "properties": {"offset": {"type": "integer", "minimum": 0}, "deletedLength": {"type": "integer", "minimum": 1}, "insertedBytes": {"type": "string"}}, "required": ["offset"]}, "result": {"additionalProperties": false, "type": "object", "properties": {"ruleId": {"type": "string"}, "ruleKey": {"type": "string"}, "level": {"default": "warning", "enum": ["notApplicable", "pass", "note", "warning", "error"]}, "message": {"type": "string"}, "formattedRuleMessage": {}, "locations": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "snippet": {"type": "string"}, "id": {"type": "string"}, "toolFingerprintContribution": {"type": "string"}, "stacks": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "codeFlows": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "relatedLocations": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "suppressionStates": {"type": "array", "items": {"enum": ["suppressedInSource", "suppressedExternally"]}}, "baselineState": {"enum": ["new", "existing", "absent"]}, "fixes": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}}, "rule": {"additionalProperties": false, "type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "shortDescription": {"type": "string"}, "fullDescription": {"type": "string"}, "messageFormats": {"type": "object"}, "defaultLevel": {"default": "warning", "enum": ["note", "warning", "error"]}, "helpUri": {"type": "string", "format": "uri"}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["id"]}, "run": {"additionalProperties": false, "type": "object", "properties": {"tool": {}, "invocation": {}, "files": {"type": "object", "additionalProperties": {}}, "logicalLocations": {"type": "object", "additionalProperties": {}}, "results": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}, "toolNotifications": {"type": "array", "items": {}}, "configurationNotifications": {"type": "array", "items": {}}, "rules": {"type": "object", "additionalProperties": {}}, "id": {"type": "string"}, "stableId": {"type": "string"}, "automationId": {"type": "string"}, "baselineId": {"type": "string"}, "architecture": {"type": "string"}}, "required": ["tool"]}, "stack": {"additionalProperties": false, "type": "object", "properties": {"message": {"type": "string"}, "frames": {"type": "array", "minItems": 1, "items": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["frames"]}, "stackFrame": {"additionalProperties": false, "type": "object", "properties": {"message": {"type": "string"}, "uri": {"type": "string", "format": "uri"}, "uriBaseId": {"type": "string"}, "line": {"type": "integer"}, "column": {"type": "integer"}, "module": {"type": "string"}, "threadId": {"type": "integer"}, "fullyQualifiedLogicalName": {"type": "string"}, "logicalLocationKey": {"type": "string"}, "address": {"type": "integer"}, "offset": {"type": "integer"}, "parameters": {"type": "array", "items": {"type": "string", "default": []}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["fullyQualifiedLogicalName"], "dependencies": {"uriBaseId": ["uri"], "line": ["uri"], "column": ["line"]}}, "tool": {"additionalProperties": false, "type": "object", "properties": {"name": {"type": "string"}, "fullName": {"type": "string"}, "version": {"type": "string"}, "semanticVersion": {"type": "string"}, "fileVersion": {"type": "string", "pattern": "[0-9]+(\\.[0-9]+){3}"}, "sarifLoggerVersion": {"type": "string"}, "language": {"type": "string"}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["name"]}}, "id": "https://json.schemastore.org/sarif-1.0.0.json", "properties": {"$schema": {"type": "string", "format": "uri"}, "version": {"enum": ["1.0.0"]}, "runs": {"type": "array", "minItems": 1, "items": {}}}, "required": ["version", "runs"], "type": "object"}
sarif-1.0.0.json
annotatedCodeLocation
An annotation used to express code flows through a method or other locations that are related to a result.
{"additionalProperties": false, "type": "object", "properties": {"id": {"type": ["integer", "string"], "pattern": "^[1-9][0-9]*$", "minimum": 1}, "step": {"type": "integer", "minimum": 0}, "physicalLocation": {}, "fullyQualifiedLogicalName": {"type": "string"}, "logicalLocationKey": {"type": "string"}, "module": {"type": "string"}, "threadId": {"type": "integer"}, "message": {"type": "string"}, "kind": {"enum": ["alias", "assignment", "branch", "call", "callReturn", "continuation", "declaration", "functionEnter", "functionExit", "functionReturn", "usage"]}, "taintKind": {"enum": ["source", "sink", "sanitizer"]}, "target": {"type": "string"}, "values": {"type": "array", "default": [], "items": {"type": "string"}}, "state": {"type": "object"}, "targetKey": {"type": "string"}, "essential": {"type": "boolean"}, "importance": {"enum": ["important", "essential", "unimportant"]}, "snippet": {"type": "string"}, "annotations": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}}
sarif-1.0.0.json
id
OBSOLETE (use "step" instead): An identifier for the location, unique within the scope of the code flow within which it occurs.
{"type": ["integer", "string"], "pattern": "^[1-9][0-9]*$", "minimum": 1}
sarif-1.0.0.json
step
The 0-based sequence number of the location in the code flow within which it occurs.
{"type": "integer", "minimum": 0}
sarif-1.0.0.json
physicalLocation
A file location to which this annotation refers.
{}
sarif-1.0.0.json
fullyQualifiedLogicalName
The fully qualified name of the method or function that is executing.
{"type": "string"}
sarif-1.0.0.json
logicalLocationKey
A key used to retrieve the annotation's logicalLocation from the logicalLocations dictionary.
{"type": "string"}
sarif-1.0.0.json
module
The name of the module that contains the code that is executing.
{"type": "string"}