description:
Slack webhook URL.

To get this URL:
1. [Create](https://api.slack.com/apps?new_app=1) a custom Slack App. Fill in the form as follows:
    - *App Name*: `Pmbot`
    - *Development Slack Workspace*: Workspace where you want Pmbot to be integrated to
2. Click "Create App". You are redirected to your app's page.
3. Under menu section *Features*, select *Incoming Webhooks*, then toggle on *Activate Incoming Webhooks*. A new section named *Webhook URLs for Your Workspace* appears.
4. Under section *Webhook URLs for Your Workspace*, click *Add New Webhook To Workspace*, then select the channel to which you want messages to be sent, for example `#pmbot`.
5. Once added, copy the webhook URL and configure this action with it


key: title

description:
Slack message title

This [handlebars](https://handlebarsjs.com/guide/#what-is-handlebars) template is passed the following context:

```
{
    "slug": "myPm",
    "status": "myStatus",
    "statusEmoji": "✅"
}
```

type: string

default: Automated update of {{slug}} dependencies {{statusEmoji}}


key: additionalText

description: Additional text to embed in the slack message body


key: name

description: Header name


key: value

description: Header value


key: url

description: Url to call


key: extraData

description: Data that will be appended to the webhook payload in property "extraData"


key: headers

description: Additional headers to append to the HTTP request

type: array


key: pattern

description: A Javascript regular expression.


key: defaultBumpRule

description: Default rule for bumping dependencies. Used unless a specific rule is configured.

enum: major minor patch


key: bumpRules

description: Bump rules for specific dependencies. The first rule to match is used. When no custom rule is found here, we fallback the default rule.


key: bumpConfig

description: Bump configuration. Patterns are matched against package names.


description: Bump configuration. Patterns are matched against dependency names formed as "<groupId>:<artifactId>" (e.g. "javax.xml.bind:jaxb-api").


key: settingsPath

description: Path to a maven `settings.xml` file which contains credentials for private repositories.


key: on

description: When to trigger this action

enum: running pending interrupted success partial failure unknown


key: enabled

description: When false, all updates are made at once and we do not wait for CI feedback.

type: boolean


key: dependency

description: Name of the dependency


key: versionBefore

description: Version of the dependency before it was updated


key: versionAfter

description: Version of the dependency after it was updated


key: packageManager

description: Package manager to use for this update

type: object

const: npm

const: maven

const: go

const: composer

config: object

const: ruby


key: ci

description: CI configuration for this update


key: branchPrefix

description: Prefix of the update branch

default: update/


key: commitMessage

description:
Commit message template

This [handlebars](https://handlebarsjs.com/guide/#what-is-handlebars) template is passed the following context:

```
{
    "dependency": "chalk",
    "versionBefore": "1.0.0",
    "versionAfter": "1.0.1"
}
```

default: chore: update {{dependency}} from {{versionBefore}} to {{versionAfter}}


key: ignore

description: List of dependencies to ignore. Each item should be a Javascript regular expression.


key: actions

description: Actions to execute after the update

const: create-issue

const: create-merge-request

const: auto-merge

const: webhook

const: slack

const: mattermost

const: email


key: keepUpdateBranchOnFailure

description: When `true`, the update branch will **not** be deleted when the package manager update status is `failure`.


description: constraints: overall size < 100000 TBD


description: avro compatible name set by creator OR derived from name (thus ignore_empty = true)


key: name

description: constraints: printable characters


key: namespace

description:
constraints:
dot separated sequence of name constraints
must be Avro compatible. When absent becomes <handle>.<name>.v<version>


description: avro compatible name set by creator OR derived from name


key: doc

description:
constraints:
size < 5000


description: constraints: same as SimpleSchemaDefinition


key: IoBJson

description: The ioBroker global config

type: number

required:
memoryLimitMB
hostname
statisticsInterval
// statisticsInterval
checkDiskInterval
// checkDiskInterval
instanceStartInterval
compact
// compact
allowShellCommands
// allowShellCommands
memLimitWarn
// memLimitWarn
memLimitError
// memLimitError

required: enabled secure password

required: level maxDays noStdout transport

required:
system
multihostService
objects
states
log
dataDir
// dataDir
plugins
// dnsResolution
dnsResolution


key: memoryLimitMB

description: do not use more than memory limit mb by ioB process (0 to deactivate)


key: hostname

description: if empty, determine use real hostname


key: statisticsInterval

description: Interval how often the counters for input/output in adapters and controller will be updated in ms


key: checkDiskInterval

description: Interval how often the disk size will be checked in ms


key: instanceStartInterval

description: interval to wait between multiple instances starts


key: compact

description: Controller will try to start the instances as a part of the same process. No spawn will be done. Only by adapters that support it and have flag compact flag in io-package.json


key: allowShellCommands

description: Allow execution of "shell" sendToHost commands


key: memLimitWarn

description: If the available RAM is below this threshold on adapter start, a warning will be logged.


key: memLimitError

description: If the available RAM is below this threshold on adapter start, an error will be logged.


key: dataDir

description: Always relative to iobroker.js-controller/


key: dnsResolution

description: Use 'verbatim' for ipv6 first, else use 'ipv4first'


key: type

description: Possible values: 'file' - [port 9001], 'jsonl' - [port 9001], 'redis' - [port 6379 or 26379 for sentinel].

enum: jsonl file redis


key: files

description: Minimal number of backup files, after the deletion will be executed according to backupTime settings


key: hours

description: All backups older than configured hours will be deleted. But only if the number of files is greater than of backupNumber


key: period

description: by default backup every 2 hours. Time is in minutes. To disable backup set the value to 0


key: path

description: Absolute path to backup directory or empty to backup in data directory


key: autoCompress

description: The JSONL DB is append-only and will contain unnecessary entries after a while. It will be compressed when the uncompressed size is >= size * sizeFactor AND >= sizeFactorMinimumSize Note that too low values here will cause the DB to be rewritten often.

required: sizeFactor sizeFactorMinimumSize


key: ignoreReadErrors

description: If single lines in the DB are corrupted, they can be ignored without losing the whole DB.


key: throttleFS

description: By default, the database immediately writes to the database file. Write accesses can be reduced using the throttleFS option. Be aware that buffered changes will be lost in case the process crashes

required:
// intervalMs
intervalMs
// maxBufferedCommands
maxBufferedCommands


key: intervalMs

description: Write to the database file no more than every intervalMs milliseconds.


key: maxBufferedCommands

description: Force writing after this many changes have been buffered. This reduces memory consumption and data loss in case of a crash.


description: Configuration file for lgtm, for continuous security analysis.

type: string object

type: array string

type: string number

default: rebuild

enum: none basic full

default: full

enum: all default disabled

type: array boolean


key: id

description: Use to identify a specific query whose results you want to include or exclude from display on LGTM.


key: severity

description: Use to specify a single level of severity (error, warning or recommendation) for queries whose results you want to include or exclude from display.


key: tags

description: Use to specify one or more tags for queries whose results you want to include or exclude from display.


description: Defines the tag that you want to modify. Usually this is a built-in tag, but you can define your own tags.


key: additionalProperties

description: Classify files on this path with the parent tag.


key: exclude

description: Do not classify files on this path with the parent tag.


description: Hide the results for queries with the specified properties.


key: include

description: Show the results for queries with the specified properties.


key: prepare

description: Customizable step used by all languages.


key: packages

description: One or more packages to install.


key: index


description: Specify that all project or solution files should be used for extraction.


key: buildless

description: Specify whether or not to extract the codebase without building the code.


key: arguments

description: Specify a list of additional arguments to dotnet build.


key: version

description: Specify the version of the .NET Core SDK to use.


description: Specify a list of files and folders to exclude from extraction. Each path is specified by defining paths relative to LGTM_SRC.


key: filetypes

description: Specify additional file types to extract.


description: Specify a list of files and folders to scan for files to extract.


description: Specify the Java version required to build the project.


key: maven

description: Specify Maven settings to use by specifying one or more of the maven subproperties detailed below.


description: Specify the path (absolute or relative) of a Maven settings file to use.


description: Specify the path of a Maven toolchains file to use.


description: Specify the required Maven version.


description: Specify a list of additional arguments to MSBuild.


key: configuration

description: Specify the MSBuild configuration to use, for example, debug or release.


key: platform

description: Specify the platform to target, for example: x86, x64, or Any CPU.


key: target

description: Specify the MSBuild target.


description: Specify whether or not to perform a NuGet restore for extraction.


description: Specify whether .properties files are extracted.


key: solution

description: Specify a list of one or more project or solution files for extraction.


key: typescript

description: pecify how TypeScript files should be extracted.


description: Specify how XML files should be extracted.


key: configure

description: Customizable step used only by C/C++ extraction.


key: command

description: Override the default process by specifying a list of commands to run to generate the build configuration.


description: This step is used only by Python blocks. It sets up the Python interpreter and virtual environment, ready for the index step to extract the codebase.


description: Specify packages to exclude from extraction/analysis.


key: requirements

description: Specify a list of pip packages to install. If any of these packages cannot be installed, the extraction will fail.


description: Specify a list of requirements text files to use to set up the environment, or false for none.


description: Specify a setup.py file to use to set up the environment, or false for none.


description: Override the version of the Python interpreter used for setup and extraction.


description: A schema for Pulumi project files.

required: name path

enum: string integer boolean array

const: array

type: integer

const: always

required: name runtime


key: name

description: Name of the plugin


key: path

description: Path to the plugin folder


description: Version of the plugin, if not set, will match any version the engine requests.


description: Name of the project containing alphanumeric characters, hyphens, underscores, and periods.


key: description

description: Description of the project.


key: author

description: Author is an optional author that created this project.


key: website

description: Website is an optional website for additional info about this project.


key: license

description: License is the optional license governing this project's usage.


key: main

description: Path to the Pulumi program. The default is the working directory.


key: config

description: A map of configuration keys to their types. Using config directory location relative to the location of Pulumi.yaml is a deprecated use of this key. Use stackConfigDir instead.


key: secret

description: If true this configuration value should be encrypted.


key: stackConfigDir

description: Config directory location relative to the location of Pulumi.yaml.


key: backend

description: Backend of the project.


key: url

description: URL is optional field to explicitly set backend url


key: options

description: Additional project options.


key: refresh

description: Set to "always" to refresh the state before performing a Pulumi operation.


key: template

description: ProjectTemplate is a Pulumi project template manifest.


description: Description of the template.


key: quickstart

description: Quickstart contains optional text to be displayed after template creation.


key: important

description: Important indicates the template is important and should be listed by default.


description: Config to apply to each stack in the project.


description: Description of the config.


key: default

description: Default value of the config.


description: Boolean indicating if the configuration is labeled as a secret.


key: plugins

description: Override for the plugin selection. Intended for use in developing pulumi plugins.


key: providers

description: Plugins for resource providers.


key: analyzers

description: Plugins for policy analyzers.


key: languages

description: Plugins for languages.


description: MTA DESCRIPTOR SCHEMA

enum: str int float bool

default: str

required: name type

required: _schema-version ID version


key: includes

description: It is possible to define parameters in external files. The "includes" section is used to point to those files.


key: name

description: The name of an "includes" section. This name is used by a builder to generate a parameter section in the deployment descriptor.


key: path

description: A path pointing to a file that contains a map of parameters, either in JSON or in YAML format.


description: An internal name which can be used for documentation purposes and shown by the deployer.


key: type

description: Defines the type of action that should be executed by the deployer.


key: phases

description: A list of strings that define the points at which the hook must be executed.


key: parameters

description: Configuration parameters that are used when executing the hook to the target runtime environment.


key: parameters-metadata

description: Additional information about the hook's parameters.


key: requires

description: List of names either matching a resource name or a provided dependency name provided within the same MTA that are required by this hook.


description: An MTA internal name which must match either a provided name, or a resource name within the same MTA.


description: Parameters can be used to influence the behavior of tools which interpret this descriptor. Parameters are not made available to the hook at runtime. Provided property values can be accessed by "~{<provided-property-name>}". Such expressions can be part of an arbitrary string


description: Defines the name of the Cloud Foundry task that should be executed.


key: command

description: Defines the actual command that is executed as a Cloud Foundry task.


key: memory

description: Defines the memory that is available to the Cloud Foundry task.


key: disk-quota

description: Defines the disk space that is available to the Cloud Foundry task.


description: The schema version that is being used for authoring a descriptor. The schema version should comply with the semantic versioning standard.


key: ID

description: An application ID, that may contain any number of unicode characters and should be unique in the target runtime environment.


key: description

description: A free text describing this application.


key: version

description: The application version that should comply with the semantic versioning standard.


key: provider

description: The provider or vendor of this application.


key: copyright

description: A copyright statement from the provider.


key: modules

description: A list of modules.


description: The MTA module name which must be unique and cannot be the same as any provided property set or resource name.


description: The module type that defines the design-time tools for the module.


description: A free text describing this module.


description: The path to a folder that contains the module artifacts.


key: deployed-after

description: A list of modules that must be deployed before deploying the current module.


key: properties

description: A collection of key-value pairs that are available to the module at runtime.


key: properties-metadata

description: Additional information about the module's properties.


description: Configuration parameters that are used when deploying the module to the target runtime environment.


description: Additional information about the module's parameters.


key: hooks

description: A list of hooks that will be executed for the module.


key: build-parameters

description: The build parameters define how the module is built by the corresponding tool.


key: includes

description: It is possible to define parameters in external files. The "includes" section is used to point to those files.


key: name

description: The name of an "includes" section. This name is used by a builder to generate a parameter section in the deployment descriptor.


key: path

description: A path pointing to a file that contains a map of parameters, either in JSON or in YAML format.


key: provides

description: Used to define the named property sets that other modules and resources can require.


description: The name of the property set that the module provides. The provided name must be unique and cannot be the same as any resource or module name.


key: public

description: Configures the accessibility of the provided property set; if set to "true", it is publicly accessible and can be consumed by other MTA projects.


description: A list of properties that are included in this property set.


description: Additional information about the provided set's properties.


key: requires

description: A list of property sets provided by other modules and/or resources (providers) that this module requires.


description: The name of a provided property set or resource (provider) that this module requires.


key: group

description: A "group" can be used to combine properties from multiple providers into one runtime lookup object, such as an environment variable. As of schema version 2.1, this property is DEPRECATED.


key: list

description: Defines a name for a runtime lookup object, such as an environment variable, if the required property set contains multiple values; for example, if used to consume configuration data from outside this MTA project.


description: Module properties whose values are determined by the provided properties. These properties can be referenced by the tilde notation: "~{<provided-property-name>}"


description: Additional information about the modules's properties.


key: parameters

description: Configuration parameters that are used when deploying the module to the target runtime environment.


key: parameters-metadata

description: Additional information about the modules's parameters.


key: resources

description: A list of resources that are required by the modules of this MTA project.


description: The resource name which must be unique and cannot be the same as any provided property set or module name.


key: type

description: A type of resource supported by deployment tools in the target environment.


key: description

description: A free text describing this resource.


key: properties

description: A collection of key-value pairs that can be required by modules and/or other resources as configuration data at runtime.


key: properties-metadata

description: Additional information about the resource's properties.


description: Configuration parameters that are used when provisioning the resource in the target runtime environment.


description: Additional information about the resource's parameters.


description: It is possible to define parameters in external files. The "includes" section is used to point to those files.


description: The name of an "includes" section. This name is used by a builder to generate a parameter section in the deployment descriptor.


description: A path pointing to a file that contains a map of parameters, either in JSON or in YAML format.


key: optional

description: If the resource is set to optional and the deployment tools are unable to allocate it, then the tools will issue a warning and continue the deployment process.


key: processed-after

description: A list containing the names of the resources that must be processed prior to this one.


key: active

description: If a resource is declared to be inactive, the resource will not be allocated during the deployment process.


description: A list of property sets provided by other modules and/or resources (providers) that this resource requires.


key: name

description: The name of a provided property set or resource (provider) that this resource requires.


description: Resource properties whose values are determined by the provided properties. These properties can be referenced by the tilde notation: "~{<provided-property-name>}"


description: Additional information about the required properties.


description: Additional information about the required parameters.


description: Global parameters that are used when building or deploying the application


description: Additional information about the global parameters.


key: JFrog-Pipelines


key: Resource

enum: Aql BuildInfo CronTrigger DistributionRule FileSpec GitRepo HelmChart Image IncomingWebhook OutgoingWebhook PropertyBag ReleaseBundle RemoteFile VmCluster


key: Pipeline

type: string number object

type: string integer

enum: image host

required: language versions

required: name tag

required: name steps


key: Step

enum: Bash CreateReleaseBundle DistributeReleaseBundle DockerBuild DockerPush GoBuild GoPublishBinary GoPublishModule GradleBuild HelmBlueGreenCleanup HelmBlueGreenDeploy HelmBlueGreenRoleSwitch HelmDeploy HelmPublish Jenkins Matrix MvnBuild NpmBuild NpmPublish PostMatrix PowerShell PreMatrix PromoteBuild PublishBuildInfo PushArtifactoryPackage SignReleaseBundle TriggerPipeline XrayScan


key: $schema

description: JSON schema for validation


key: common

description: Contains all common instance attributes

required: name version platform titleLang news desc mode

const: json

enum: html json materialize none

enum: html materialize

type: string array

enum: alarm climate-control communication date-and-time energy metering garden general geoposition hardware health household infrastructure iot-systems lighting logic messaging misc-data multimedia network protocols storage utility vehicle visualization visualization-icons visualization-widgets weather

required: name path width align

enum: left right center justify

required: fa-icon link name

enum: none daemon subscribe schedule once extension

enum: none local cloud

enum: none poll push assumption

type: object string

enum: silly debug info warn error

enum: linux darwin win32


description: Name of the adapter without ioBroker


key: version

description: Current adapter version


key: platform

description: Platform, normally Javascript/Node.js


key: title

description: Longer name of adapter DEPRECATED: For admin version >= 5 this property is no longer required


key: titleLang

description: Longer name of adapter in all supported languages like {en: 'Adapter', de: 'adapter', ru: 'Драйвер'}


key: news

description: Short form of changelog in all supported languages


key: desc

description: Description, object for multilingual description


key: messagebox

description: true if messagebox supported. Hence, the adapter can receive sendTo messages. Up from controller v5, please use common.supportedMessages.notifications.custom = true


key: supportedMessages

description: Object which defines, if the adapter supports receiving messages via sendTo. Additionally, it defines if specific messages are supported.


key: custom

description: If custom messages are supported (same as legacy messagebox)


key: notifications

description: If notification handling is supported, for information, see https://github.com/foxriver76/ioBroker.notification-manager#requirements-for-messaging-adapters


key: stopInstance

description: If adapter supports signal stopInstance. Use number if you need more than 1000 ms for stop routine. The signal will be sent before stop to the adapter. (used if problems occurred with SIGTERM). (Same as legacy `supportStopInstance`)


key: getHistory

description: If adapter supports getHistory message. (Same as legacy `getHistory`, to avoid problems, set both flags in parallel for now)


key: readme

description: Url of the ReadMe file


key: adminUI

description: Type of the admin UI


description: UI type of custom tab inside admin UI


key: config

description: UI type of config page inside admin UI


key: tab

description: UI type of tab inside admin UI


key: docs

description: The structure like {"en": "docs/en/README.md", "de": ["docs/de/README.md", "docs/de/README1.md"]} that describes the documentation if not in README.md


key: authors

description: Array of authors as string


key: license

description: License of the software


key: type

description: Type of the adapter


key: unsafePerm

description: if the package must be installed with "npm --unsafe-perm" parameter


key: plugins

description: ioBroker plugins to be used


key: adminColumns

description: Custom attributes, that must be shown in admin in the object browser. Like: [{"name": {"en": "KNX address"}, "path": "native.address", "width": 100, "align": "left"}, {"name": "DPT", "path": "native.dpt", "width": 100, "align": "right", "type": "number", "edit": true, "objTypes": ["state", "channel"]}]. type is a type of the attribute (e.g. string, number, boolean) and only needed if edit is enabled. objTypes is a list of the object types, that could have such attribute. Used only in edit mode too.


key: adminTab

description: Adds a Tab which can be shown in admin adapter


key: fa-icon

description: Font-Awesome icon name for TAB


key: ignoreConfigUpdate

description: Do not update config TAB if configuration changed (to enable configure settings in TAB)


key: link

description: Link for iframe in the TAB. You can use parameters replacement like this: "https://%ip%:%port%". IP will be replaced with host IP. "port" will be extracted from native.port.


key: name

description: Name of TAB (multilingual object) in admin


key: singleton

description: If true, only one TAB for all instances will be shown.


key: controller

description: Only used by js-controller


key: allowInit

description: allow for "scheduled" adapter to be called "not in the time schedule", if settings changed or adapter started. Or allow scheduled adapter start once after configuration changed and then by schedule.


key: availableModes

description: values for common.mode if more than one mode is possible


key: blockly

description: if adapter has custom blocks for blockly (admin/blockly.js required)


key: connectionType

description: Type of connection to device


key: compact

description: If compact mode supported


key: dataFolder

description: Folder relative to iobroker-data where the adapter stores the data. This folder will be backed up and restored automatically. You can use variable '%INSTANCE%' in it


key: dataSource

description: How the data will be received from device


key: dependencies

description: Array like [{"js-controller": ">=2.0.0"}] that describes which ioBroker modules are required for this adapter on the same host


key: enabled

description: Value should be false so new instances are disabled by default


key: eraseOnUpload

description: erase all previous data in the directory before upload


key: extIcon

description: Link to external icon for uninstalled adapters. Normally on GitHub


key: getHistory

description: if adapter supports getHistory message. (Up from controller v5, please use `common.supportedMessages.getHistory`)


key: globalDependencies

description: Array like [{"admin": ">=2.0.0"}] that describes which ioBroker modules are required for this adapter on one of the hosts


key: icon

description: name of the local icon (should be located in subdirectory "admin")


key: keywords

description: Similar to keywords in package.json, but can be defined in many languages.


key: localLinks

description: Link to the web service of this adapter. E.g {"_default": "http://localhost:5984/_utils"} for button in admin


key: loglevel

description: Default Loglevel after instance creation


key: logTransporter

description: If this adapter receives logs from other hosts and adapters (e.g. to store them somewhere)


key: main

description: Name of the start file. DEPRECATED: For controller >= 3.3 please use package.json main.


key: materialize

description: If adapter supports > admin3 (materialize style) DEPRECATED: For admin version >= 5 please use the property 'adminUI'


key: materializeTab

description: If adapter supports > admin3 for tab (materialize style) DEPRECATED: For admin version >= 5 please use the property 'adminUI'


key: mode

description: Execution mode of the adapter


key: noConfig

description: Do not show configuration dialog for instance DEPRECATED: For admin version >= 5 please use adminUI.config = "none"


key: noIntro

description: never show instances of this adapter on Intro/Overview screen in admin (like icons, widgets)


key: noRepository

description: If adapter delivered with initial installation or has own repository


key: nogit

description: If true, no install from github directly is possible


key: nondeletable

description: This adapter cannot be deleted or updated. It will be updated together with controller.


key: onlyWWW

description: Say to controller, that adapter has only html files and no main.js, like rickshaw


key: osDependencies

description: OS packages which should be installed on adapter installation


key: os

description: String or array of supported operation systems, e.g ["linux", "darwin"]


key: preserveSettings

description: String (or array) with names of attributes in common of instance, which will not be deleted. E.g. "history", so by setState('system.adapter.mqtt.0", {..}) the field common.history will not be deleted even if new object does not have this field. To delete the attribute it must be explicitly done with common:{history: null}.


key: restartAdapters

description: Array with names of adapter that must be restarted after this adapter is installed, e.g. ["vis"]


key: restartSchedule

description: CRON schedule to restart mode daemon adapters


key: schedule

description: CRON schedule if adapter runs in mode schedule


key: serviceStates

description: If adapter can deliver additional states. If true, the path adapter/lib/states.js (or given path as string) will be called and it give following parameters function (objects, states, instance, config, callback). The function must deliver the array of points with values like function (err, result) { result = [{id: 'id1', val: 1}, {id: 'id2', val: 2}]}

type: boolean string


key: singletonHost

description: Adapter can be installed only once on one host


key: singleton

description: Adapter can be installed only once in whole system


key: stopBeforeUpdate

description: If adapter must be stopped before update


key: stopTimeout

description: timeout in ms to wait, till adapter shut down


key: subscribable

description: Variables of this adapter must be subscribed with sendTo to enable updates


key: subscribe

description: Name of variable, that is subscribed automatically


key: supportCustoms

description: If the adapter support settings for every state. It has to have custom.html file in admin. Sample can be found in ioBroker.history


key: supportStopInstance

description: If adapter supports signal stopInstance (messagebox required). Use number if you need more than 1000 ms for stop routine. The signal will be sent before stop to the adapter. (used if problems occurred with SIGTERM). (Up from controller v5, please use `common.supportedMessages.stopInstance`)


key: visWidgets

description: Overview of vis 2 widgets provided by the adapter, define the name of the provided sets as keys

required: url components i18n

const: component


description: The key represents the name of a provided widget set


description: Translation for the widget


Translations will be loaded from visWidgets.<SET_NAME>.url and i18n/<LANG>.json


description: Translations will be loaded from customComponent.js with name ./translations


description: Define translations here


key: url

description: Relative path ('http://ip:port/vis/widgets/' + url) or full url to load component from


key: components

description: Names of widgets which have to be shown, normally equal to the content of 'modulefederation.config.js'


key: wakeup

description: Adapter will be started if some value is written into system.adapter.NAME.x.wakeup. Normally the adapter should stop after processing of event.


key: webByVersion

description: Show version as prefix in web adapter (usually - ip:port/material, webByVersion - ip:port/1.2.3/material)


key: webExtendable

description: If web server in this adapter can be extended with plugin/extensions like proxy, simple-api


key: webExtension

description: Relative filename to connect the web extension. E.g. in simple-api "lib/simpleapi.js" relative to the adapter root directory. Additionally is native.webInstance required to say where this extension will be included. Empty means, it must run as own web service. "*" means every web server must include it.


key: webPreSettings

description: Object of parameters that must be included into info.js by webServer adapter. (Example material)


key: webservers

description: Array of web server's instances that should serve content from the adapters www folder


key: welcomeScreen

description: Array of pages, that should be shown on the "web" index.html page. ["vis/edit.html", "vis/index.html"] or [{"link": "vis/edit.html", "name": "Vis editor", "img": "vis/img/edit.png", "color": "blue"}, "vis/index.html"]


key: welcomeScreenPro

description: Array of pages used on access via ioBroker cloud, that should be shown on the "web" index.html page. ["vis/edit.html", "vis/index.html"] or [{"link": "vis/edit.html", "name": "Vis editor", "img": "vis/img/edit.png", "color": "blue"}, "vis/index.html"]


key: wwwDontUpload

description: Do not upload the www directory into DB. Used only for admin.


key: tier

description: Lower tiers are started before higher tiers instances, TIER 1: LOGIC, TIER 2: APIs & other data, TIER 3: not fastly needed data, like BackItUp, Visualization, etc.


key: messages

description: Messages can be shown on adapter installation, update and instance creation

required: title text buttons

enum: or and

default: and

enum: info warn error

default: warn

enum: ok agree cancel


key: condition

description: Message will only be shown if condition matches


key: operand

description: Operand to connect multiple rules


key: rules

description: Rules which need to be true, e.g. ["oldVersion<2.0.0", "newVersion>=2.0.0"]


key: title

description: Title of the shown message


key: text

description: Text of the shown message


key: link

description: You can define a hyperlink, which will be shown, define its text with `linkText`


key: level

description: The importance of the message


key: linkText

description: If a link is defined and should be embedded in text, you can define the text here


key: buttons

description: Predefined buttons of the message window


key: objects

description: Objects which will be created for the adapter


key: instanceObjects

description: Objects which will be created for each instance


key: notifications

description: Register notifications for the built-in notification system

required: scope name description categories

required: category name severity description regex limit

enum: info notify alert


key: name

description: Name which will be shown to the user


key: description

description: Description which will be shown to the user


key: severity

description: `info` will only be shown by admin, while `notify` might also be used by messaging adapters, `alert` ensures both


key: limit

description: Maximum amount of notifications to collect of this type


key: native

description: Predefined attributes which are accessible in index_m.html and at runtime via adapter.config.<attribute>, e.g. {"port": 1234, "password": "secret"}


key: protectedNative

description: Array of config attributes which will only be accessible by the own adapter, e.g. ["password"]


key: encryptedNative

description: Array of config attributes which will be automatically encrypted when stored via Admin configuration page and automatically decrypted at adapter runtime, e.g. ["password", "token"]


key: distinct

description:
An expr expression that must return a string. The event will be
poured only if the string is not already present in the bucket.


key: capacity

description:
Only applies to leaky buckets. A positive integer
representing the bucket capacity. If there are more than
capacity item in the bucket, it will overflow.


description:
By default, a bucket holds capacity events "in memory". However,
for a number of cases, you don't want this, as it might lead to
excessive memory consumption.  By setting cache_size to a
positive integer, we can control the maximum in-memory cache
size of the bucket, without changing its capacity and such. It
is useful when buckets are likely to stay alive for a long time
or ingest a lot of events to avoid storing a lot of events in
memory.


description:
overflow_filter is an expression that is run when the bucket
overflows. If this expression is present and returns false, the
overflow will be discarded.


key: filter

description:
filter must be a valid expr expression that will be evaluated
against the event.  If filter evaluation returns true or is
absent, event will be pour in the bucket.  If filter returns
false or a non-boolean, the event will be skipped for this
bucket.


key: type

description:
Defines the type of the bucket. Currently three types are
supported : leaky : a leaky bucket that must be configured
with a capacity and a leakspeed trigger : a bucket that
overflows as soon as an event is poured (it is like a leaky
bucket is a capacity of 0) counter : a bucket that only
overflows every duration. It is especially useful to count
things.


key: reprocess

description:
If set to true, the resulting overflow will be sent again in the
scenario/parsing pipeline. It is useful when you want to have
further scenarios that will rely on past-overflows to take
decision


description:
"github_account_name/my_scenario_name" or name:
"my_author_name/my_scenario_name" name is mandatory


description:
The description is mandatory.  It is a short description,
probably one sentence, describing what it detects.


key: leakspeed

description:
Only applies to leaky buckets. A duration that represent how
often an event will be leaking from the bucket.


description:
cancel_on is an expression that runs on each event poured to the
bucket. If the cancel_on expression returns true, the bucket is
immediately destroyed (and doesn't overflow).


key: format

description:
CrowdSec has a notion of format support for parsers and
scenarios for compatibility management. Running cscli version
will show you such compatibility matrix :


key: debug

description:
If set to to true, enabled scenario level debugging. It is meant
to help understanding scenario behavior by providing contextual


key: scope

description:
While most scenarios might focus on IP addresses, CrowdSec and Bouncers can work with any scope. The scope directive allows you to override the default scope :
    type is a string representing the scope name
    expression is an expr expression that will be evaluated to fetch the value


key: groupby

description:
An expr expression that must return a string. This string will
be used as a partition for the buckets.


key: references

description: Reference to external paper or documentation


key: blackhole

description:
A duration for which a bucket will be "silenced" after
overflowing. This is intended to limit / avoid spam of buckets
that might be very rapidly triggered.  The blackhole only
applies to the individual bucket rather than the whole
scenario. Must be compatible with golang ParseDuration format.


description:
An expr expression that must return a string. The event will be
poured only if the string is not already present in the bucket.


key: condition

description: Make the bucket overflow when it returns true. The expression is evaluated each time an event is poured to the bucket.


description:
Only applies to leaky buckets. A positive integer
representing the bucket capacity. If there are more than
capacity item in the bucket, it will overflow.


description:
By default, a bucket holds capacity events "in memory". However,
for a number of cases, you don't want this, as it might lead to
excessive memory consumption.  By setting cache_size to a
positive integer, we can control the maximum in-memory cache
size of the bucket, without changing its capacity and such. It
is useful when buckets are likely to stay alive for a long time
or ingest a lot of events to avoid storing a lot of events in
memory.


key: labels

description:
Labels is a list of label: values that provide context to an
overflow. The labels are (currently) not stored in the database,
nor they are sent to the API.  Special labels : The remediation
label, if set to true indicate the the originating IP should be
banned.

type: string boolean array integer


description:
While most scenarios might focus on IP addresses, CrowdSec
and Bouncers can work with any scope. The scope directive
allows you to override the default scope : type is a string
representing the scope name expression is an expr expression
that will be evaluated to fetch the value


key: name

description:
"github_account_name/my_scenario_name" or name:
  "my_author_name/my_scenario_name" name is mandatory


description:
If set to true, the resulting overflow will be sent again in the
scenario/parsing pipeline. It is useful when you want to have
further scenarios that will rely on past-overflows to take
decision


description:
Defines the type of the bucket. Currently three types are
supported : leaky : a leaky bucket that must be configured
with a capacity and a leakspeed trigger : a bucket that
overflows as soon as an event is poured (it is like a leaky
bucket is a capacity of 0) counter : a bucket that only
overflows every duration. It is especially useful to count
things.


description:
overflow_filter is an expression that is run when the bucket
overflows. If this expression is present and returns false, the
overflow will be discarded.


description:
filter must be a valid expr expression that will be evaluated
against the event.  If filter evaluation returns true or is
absent, event will be pour in the bucket.  If filter returns
false or a non-boolean, the event will be skipped for this
bucket.


description:
cancel_on is an expression that runs on each event poured to the
bucket. If the cancel_on expression returns true, the bucket is
immediately destroyed (and doesn't overflow).


description:
CrowdSec has a notion of format support for parsers and
scenarios for compatibility management. Running cscli version
will show you such compatibility matrix :


description:
If set to to true, enabled scenario level debugging. It is meant
to help understanding scenario behavior by providing contextual


description:
An expr expression that must return a string. This string will
be used as a partition for the buckets.


description:
While most scenarios might focus on IP addresses, CrowdSec and Bouncers can work with any scope. The scope directive allows you to override the default scope :
    type is a string representing the scope name
    expression is an expr expression that will be evaluated to fetch the value


description: Reference to external paper or documentation


description:
A duration for which a bucket will be "silenced" after
overflowing. This is intended to limit / avoid spam of buckets
that might be very rapidly triggered.  The blackhole only
applies to the individual bucket rather than the whole
scenario. Must be compatible with golang ParseDuration format.


description:
An expr expression that must return a string. The event will be
poured only if the string is not already present in the bucket.


key: duration

description:
Only applies to leaky buckets.
A duration that represent how often an event will be leaking from the bucket.


key: description

description:
The description is mandatory.  It is a short description,
probably one sentence, describing what it detects.


key: data

description:
data allows user to specify an external source of data. This
section is only relevant when cscli is used to install parser
from hub, as it will download the source_url and store it to
dest_file. When the parser is not installed from the hub,
CrowdSec won't download the URL, but the file must exist for the
parser to be loaded correctly.

pattern: ^(string|regexp)$


description:
The type is mandatory if you want to evaluate the data in
the file, and should be regex for valid (re2) regular
expression per line or string for string per line. The
regexps will be compiled, the strings will be loaded into
a list and both will be kept in memory. Without specifying
a type, the file will be downloaded and stored as file and
not in memory.


description: url to download file from


description: destination to store the downloaded file to


key: engineOptions

description: The options to configure the chosen browser engine for Chutzpah to use.


key: ChromeBrowserPath

description: The path to the chrome/chromium executable on the machine


key: serverSettings

description: Server settings let you enable to configure Chutzpah web server mode.


key: Enabled

description: Determines if the web server mode is enabled.


key: DefaultPort

description: The default port to use. If this port is taken Chutzpah will try incrementing until it finds an available one.


key: RootPath

description: The root path of the server. All file paths are relative to this and should be in a directory below or equal to this. Defaults to drive root.


key: Mode

description: The way the template is injected into the HTML page.

enum: Raw Script

default: Raw


key: Id

description: If in script mode what Id to place on the script tag.


key: Type

description: If in script mode what Type to place on script tag


key: Path

description: The path to either a file or a folder. If given a folder, it will be scanned recursively. This path can be relative to the location of the chutzpah.json file.


key: Includes

description: This is an optional array of include glob patterns. Only files matching the Include pattern will be added.


key: Excludes

description: This is an optional array of exclude glob patterns.  Only files not matching the Exclude patterns will be added.


key: IncludeInTestHarness

description: This determines if the reference should be injected into the test harness. When referencing files like .d.ts or files that you plan to load using require.js you should set this to false. Defaults to true.


key: IsTestFrameworkFile

description: Indicated that this references should be placed directly after the test framework files in the test harness. This ensures that this file is injected into the test harness before almost all other files. Defaults to false.


key: SourcePath

description: The source file/directory


key: OutputPath

description: The file/directory that source file/directory is mapped to. Specifying a file OutputPath and a directory for SourcePath indicated the files are being concatenated into one large file


key: OutputPathType

description: The type (file or folder) that the output path refers to. If not specified Chutzpah will try to take a best guess by assuming it is a file if it has a .js extension

enum: File Folder

default: Folder


key: Name

description: The name of the transform to execute


description: The file for the transform to save its output to.


key: compileSettings

description: This setting lets you describe in the Chutzpah.json file how to execute a command which can compile your source files to .js files. You tell Chutzpah what to execute and some information about what your executable does (like where to find the generated .js files). Then after running the executable Chutzpah can associate each source file with each output file to still give the nice behavior of mapping tests back to their original files.

enum: Executable External

default: External


key: Extensions

description: The extensions of the files which are getting compiled (e.g. .ts).


key: ExtensionsWithNoOutput

description: The extensions of files which take part in compile but have no build output. This is used for cases like TypeScript declaration files which share a .ts extension. They have .d.ts extension and are part of compilation but have no output. You must tell Chutzpah about these if you want the SkipIfUnchanged setting to work. Otherwise Chutzpah will think these are missing output.


key: Paths

description: The collection of path mapping from source directory/file to output directory/file.


key: WorkingDirectory

description: This is the working directory of the process which executes the command.


key: Executable

description: The path to an executable which Chutzpah executes to perform the batch compilation. Chutzpah will try to resolve the path relative to the settings directory. But if can't find the file there you must give it a full path.


key: Arguments

description: The arguments to pass to the command.


key: Timeout

description: How long to wait for compile to finish in milliseconds?


key: SkipIfUnchanged

description: Skips the execution if all files Chutzpah knows about are older than all of the output files. This is defaulted to true but if you hit issues since it is possible Chutzpah might not know about all the files your compilation is using then you can turn this off. Ideally you should tell Chutzpah about these files using the references and tests settings since this setting helps Chutzpah not need to even invoke the executable if it figures out it's not needed.


key: Mode

description: Determines how this compile setting is used. By default it is in Executable mode where it will require you provide an executable which Chutzpah will run if it sees it finds missing .js for input file. If you set this to External then Chutzpah will ignore the Executable, Arguments settings and assume you have some external process which is compiling. In this case Chutzpah will use the SourceDirectory and OutDirectory options to try to find your .js files for the input files. If it can't find them it will trace an error but still attempt to proceed.


key: UseSourceMaps

description: Configures whether .map files should be loaded (if available) to convert under-test JS line numbers to those of their original source files.


key: IgnoreMissingFiles

description: Should Chutzpah ignore files it expects to find compiled. If set to true Chutzpah will log an error otherwise it will throw


key: Framework

description: Determines what testing framework to use. This will override the other detection methods.

enum: qunit jasmine mocha


key: FrameworkVersion

description: Tells Chutzpah if it should use a different version of on of the test frameworks than the default one. Currently, the only framework this works for is Jasmine. As of the 3.1.0 release Chutzpah default to Jasmine 2.0 but if you want to use the 1.0 line for Jasmine still pass '1' for FrameworkVersion.


key: References

description: The references setting allows you to specify which files/folders to use/scan to find references. This is useful since it replaces the need to the ///<reference comments.


key: Tests


key: Engine

description: The browser engine to use to run the tests. Default is Phantom but JSDOM and Chrome are available. If you choose Chrome you must have an instance of Chrome or Chromium on the machine that Chutzpah can find.

enum: Phantom JSDom Chrome


key: Transforms

description: List of transformers to run after testing to generate output files


key: TestFileTimeout

description: The time to wait for tests in a file to finish in milliseconds.


key: TestHarnessLocationMode

description: Determines where to place the generated html test harness files. The default mode is TestFileAdjacent which means the harness is placed in the same directory as the test file. SettingsFileAdjacent means it is placed in the same directory as the chutzpah.json file. Custom mode lets you specify a custom path to the directory.


key: TestHarnessDirectory

description: When TestHarnessLocationMode is set to Custom this is either the relative or absolute path to the directory where to place the test harness.


key: RootReferencePathMode

description: This property determines what directory a rooted reference path refers to.

enum: DriveRoot SettingsFileDirectory

default: DriveRoot


key: CodeCoverageTimeout

description: The timeout in milliseconds for how long to wait to instrument each file for code coverage. Defaults to 5000ms.


key: CodeCoverageExecutionMode

description: If Always, forces code coverage to run always. If Manual/null/not set, allows code coverage to run if invoked using test adapter, command line or context menu options (default). If Never, forces code coverage to never run.

enum: Manual Always Never


key: CodeCoverageSuccessPercentage

description: The percentage of lines needing to be covered to show the coverage output as success or failure. By default this is 60.


key: CodeCoverageIncludes

description: The collection code coverage file patterns to include in coverage. These are in glob format. If you specify none all files are included.


key: CodeCoverageExcludes

description: The collection code coverage file patterns to exclude in coverage. These are in glob format. If you specify none no files are excluded.


key: CustomTestHarnessPath

description: The CustomTestHarnessPath setting allows you to override the default template Chutzpah uses for the HTML test harness. This is an advanced feature which should only be used as a last resort.


key: MochaInterface

description: The name of the Mocha interface to use. Overrides the default detection mechanism.

enum: bdd tdd qunit


key: AMDBaseUrl

description: Set the baseurl for Chutzpah to use when generating the test harness. Defaults to the test harness directory if not set.


key: AMDAppDirectory

description: Sets the root directory for your AMD paths. This is only needed if your baseUrl is a different location than your source directory. This is common if you are compiling from another language to JavaScript and copying those compiled files to a different folder. For example if you have all your .ts files in /src and you compile them to a /out directory then your AMDBaseUrl is /out and AMDAppDirectory is /src. Defaults to the test harness directory if not set.


key: UserAgent

description: The user agent to use when making web requests


key: TestPattern

description: When Chutzpah reports test results it also tells you what line they are on. The way this is accomplished is by having a regex for each testing framework which describes where to find the names of your tests.

format: regex


key: EnableTestFileBatching

description: Determines if batch all test files for this chutzpah.json file should be batched into one test harness. This will often make your test run much faster.


key: InheritFromParent

description: Determines if this settings file should inherit and merge with the settings of its parent settings file. The parent is found by recursively walking up the tree.


key: IgnoreResourceLoadingErrors

description: Suppress errors that are reported when a script request to load a url (e.g. xhr/script/image) fails.


key: EnableTracing

description: Logs tracing information to a log file.


key: TraceFilePath

description: The path to write the trace file to. Defaults tp %temp%/chutzpah.log.


key: Parallelism

description: Max degree of parallelism for running tests. Defaults to number of CPUs


key: BrowserArguments

description: The dictionary of browser name (keys) to corresponding browser arguments (values), i.e.; { 'chrome': '--allow-file-access-from-files' }.


description: The OSS-Review-Toolkit (ORT) provides a possibility to configure exclusions, resolutions and more in a file called `.ort.yml`. A full list of all available options can be found at https://github.com/oss-review-toolkit/ort/blob/main/docs/config-file-ort-yml.md.

required: pattern reason

type: integer string

required: path concluded_license reason


key: excludes

description: Defines which parts of a repository should be excluded.

type: string


key: pattern

description: A glob to match the path of the project definition file, relative to the root of the repository.


key: curations

description: Curations for artifacts in a repository.

type: array


description: A configuration for a specific package and provenance.


description: A configuration to select a license from a multi-licensed package.


key: $schema

description: Ignored. Can be set to get completions, validations and documentation in some editors.


key: alias

description: Aliases that will get assigned when the deployment is `READY` and the target is `production`. The client needs to make a `GET` request to its API to ensure the assignment


key: build

description: An object containing another object with information to be passed to the Build Process


key: env

description: An object containing the deployment's environment variable names and values to be passed to Builds. Secrets can be referenced by prefixing the value with `@`


key: builds

description: A list of build descriptions whose src references valid source files.


key: config

description: Optionally, an object including arbitrary metadata to be passed to the Builder


key: src

description: A glob expression or pathname. If more than one file is resolved, one build will be created per matched file. It can include `*` and `**`


key: use

description: An npm module to be installed by the build process. It can include a semver compatible version (e.g.: `@org/proj@1`)


key: cleanUrls

description: When set to `true`, all HTML files and Serverless Functions will have their extension removed. When visiting a path that ends with the extension, a 308 response will redirect the client to the extensionless path.

type: boolean


description: An object containing the deployment's environment variable names and values. Secrets can be referenced by prefixing the value with `@`

type: object


key: functions

description: An object describing custom options for your Serverless Functions. Each key must be glob pattern that matches the paths of the Serverless Functions you would like to customize (like `api/*.js` or `api/test.js`).

type: number


key: excludeFiles

description: A glob pattern to match files that should be excluded from your Serverless Function. If you’re using a Community Runtime, the behavior might vary.


key: includeFiles

description: A glob pattern to match files that should be included in your Serverless Function. If you’re using a Community Runtime, the behavior might vary.


key: maxDuration

description: An integer defining how long your Serverless Function should be allowed to run on every request in seconds (between 1 and the maximum limit of your plan).


key: memory

description: An integer defining the memory your Serverless Function should be provided with (between 128 and 3008).


key: runtime

description: The npm package name of a Runtime, including its version


key: deploymentEnabled

description: Specifies the branches that will not trigger an auto-deployment when committing to them. Any non specified branch is `true` by default.


key: autoAlias

description: When set to `false`, Vercel for GitHub will not deploy the given project regardless of the GitHub app being installed.


key: autoJobCancelation

description: When set to `false`, Vercel for GitHub will always build pushes in sequence without cancelling a build for the most recent commit.


key: enabled

description: When set to false, Vercel for GitHub will not apply the alias upon merge.


key: silent

description: When set to `true`, Vercel for GitHub will stop commenting on pull requests and commits.


key: headers

description: A list of header definitions.

required: source headers

required: key value

required: type value

required: type key

enum: header cookie query


key: source

description: A pattern that matches each incoming pathname (excluding querystring)


description: An array of key/value pairs representing each response header.


key: has

description: An array of requirements that are needed to match


key: type

description: The type of request element to check


key: value

description: A regular expression used to match the value. Named groups can be used in the destination


description: The type of request element to check


key: key

description: The name of the element contained in the particular type


key: missing


key: name

description: A name for the deployment


key: public

description: Whether a deployment's source and logs are available publicly


key: redirects

description: A list of redirect definitions.

required: source destination


description: A pattern that matches each incoming pathname (excluding querystring).


key: destination

description: A location destination defined as an absolute pathname or external URL.


key: permanent

description: A boolean to toggle between permanent and temporary redirect. When `true`, the status code is `308`. When `false` the status code is `307`.


key: regions

description: An array of the regions the deployment's Serverless Functions should be deployed to

example: sfo bru


key: rewrites

description: A list of rewrite definitions.


description: An absolute pathname to an existing resource or an external URL.


key: routes

description: A list of routes objects used to rewrite paths to point towards other internal or external paths

src: /docs

enum: error filesystem hit miss resource rewrite


key: scope

description: This property determines the scope (user or team) under which the project will be deployed by Vercel CLI.


key: trailingSlash

description: When `false`, visiting a path that ends with a forward slash will respond with a `308` status code and redirect to the path without the trailing slash.


key: buildCommand

description: The build command for this project. When `null` is used this value will be automatically detected


key: devCommand

description: The dev command for this project. When `null` is used this value will be automatically detected


key: framework

description: The framework that is being used for this project. When `null` is used no framework is selected


key: installCommand

description: The install command for this project. When `null` is used this value will be automatically detected


key: outputDirectory

description: The output directory of the project. When `null` is used this value will be automatically detected


key: crons

description: An array of cron jobs that should be created for production Deployments.

required: schedule path


description: Orchestrate Workflows consisting of Google Cloud APIs, SaaS APIs or private API endpoints.

format: uri

enum: GET HEAD POST PUT DELETE CONNECT OPTIONS TRACE PATCH

const: end

const: continue

const: break

required: value steps

const: continueAll


key: subworkflow

description: A subworkflow.


key: params

description: The name of the parameter variable.


key: steps

description: An array of objects with a single step.


key: stepArray

description: An array of objects with a single step.


key: items

description: An object with a single step.


A single workflow step.


key: step

description: A single workflow step.


key: assign

description: A list of variable assignment maps.


description: A single variable assignment.


key: call

description: Run a function and return a result.


description: Standard library module for HTTP/S request support.


description: Standard library module for common system interface.


description: Standard library module for event support.


description: A subworkflow.


description: A Google Cloud API connector.


key: args

description: Pass arguments and their values when calling a function that accepts parameters.


key: url

description: URL where the request is sent. Required if using call type http.request.


description: An expression that results to a URL where the request is sent. Required if using call type http.request.


key: method

description: The type of HTTP request method to use. Required if using call type http.request.


key: headers

description: Header fields to supply input to the API.


key: body

description: Body fields to supply input to the API.


key: query

description: Query fields to supply input to the API.


key: auth

description: Required if the API being called requires authentication.


key: type

description: The type of authentication.


key: scope

description: Specify token scope to limit an application's access to a user's account.


description: List of scope strings.


description: Scope string.


key: scopes


key: audience

description: Specifies the audience for the OIDC token. By default, it's set to the same value as url; however, it should be set to your service's root URL.


key: timeout

description: Time in seconds. How long a request is allowed to run before throwing an exception. Default and maximum values vary by call.


description: Connector-specific parameters.


description: Time in seconds. The end-to-end duration the connector call is allowed to run for before throwing a timeout exception.


description: Polling policy.


description: Time in seconds. Only applies to long-running operation calls.


key: multiplier


description: If set to True, the connector invocation call is non-blocking if the initial request to manage or update the resource succeeds


description: OAuth2 scopes to pass to the Google API.


key: result

description: Assign the result from a call to this variable.


key: next

description: Define what step Workflows should execute next.


description: The step name.


description: Stop a workflow's execution without returning a value.


description: Terminate the current iteration of a for loop and continue with the next iteration.


description: Terminate iteration of a for loop.


key: return

description: Stop a workflow's execution and return a value, variable, or expression.


key: for

description: Iterates over a sequence of numbers or through a collection of data, such as a list or map.


key: value

description: A loop variable name. Contains the value of the currently iterated element.


key: index

description: An index variable name. Contains the value to the current offset of the iteration.


key: in

description: An expression that evaluates into a list or a list definition. Required, if not using 'range'.


description: A list.


description: An expression that evaluates into a list.


key: range

description: A list of two expressions, specifying the beginning and end of the range, both inclusive. Required, if not using 'in'.


description: Array specifying the beginning and end of the range, both inclusive.


description: The expressions must evaluate into incrementable values; that is, integer or double. Make sure that you do not use multiple expressions inside a list like this: [${rangeStart}, ${rangeEnd}]).


key: steps

description: Each iteration the steps will be executed.


key: parallel

description: Define a part of your workflow where two or more steps can execute concurrently. A 'parallel' step waits until all the steps defined within it have completed or are interrupted by an unhandled exception; execution then continues.


description: The action for other branches when an exception occurs. Optional. The default policy, 'continueAll', results in no further action, and all other branches will attempt to run.


key: shared

description: A list of writable variables with parent scope that allow assignments within the 'parallel' step.


description: The maximum number of branches and iterations that can concurrently execute within a single workflow execution before further branches and iterations are queued to wait. This applies to a single 'parallel' step only and does not cascade. Must be a positive integer and can be either a literal value or an expression.


key: branches

description: Branches that can run concurrently. Required, if not using 'for'.


description: A loop where iterations can run concurrently. Required, if not using 'branches'.


description: Execute parallel branches concurrently and the steps in each branch sequentially.


key: switch

description: A switch block. A selection mechanism that allows the value of an expression to control the flow of a workflow's execution. If a value matches, that condition's statement is executed.


key: condition

description: Define conditional expressions for a switch block.


description: An expression to switch on.


key: raise

description: Raise an exception.


description: Error message string.


description: Error message map.


key: code

description: Error code.


key: message

description: Error message string.


key: try

description: A try/except structure for error handling.


description: A step.


description: A list of steps.


key: except


key: as

description: The name of a map variable that contains the error message.


description: A list of steps.


key: retry

description: Define a retry policy to retry steps that return a specific error code.


description: Retry block. Optional, if using a default retry policy.


key: predicate

description: Defines which error codes will be retried. Options include ${http.default_retry_predicate}, ${http.default_retry_predicate_non_idempotent}, or a custom predicate defined as a subworkflow.


description: Maximum number of times a step will be retried, not counting the initial step execution attempt.


key: backoff

description: Block that controls how retries occur.


description: Delay in seconds between the initial failure and the first retry.


description: Maximum delay in seconds between retries.


key: multiplier

description: Multiplier applied to the previous delay to calculate the delay for the subsequent retry.


description: Default retry policy. Optional, if using retry block. Options include ${http.default_retry} and ${http.default_retry_non_idempotent}.


key: scopes

description: Specify token scope to limit an application's access to a user's account.


description: List of scope strings.


description: Scope string.


description: Space and comma-separated strings


description: The main workflow.


key: params

description: The name of the parameter variable.


key: steps

description: An array of objects with a single step.


A list of steps.


description: API responses from the OpenWeather Current Weather Data API from https://openweathermap.org/current

required: lat lon

required: id main description icon

required: speed deg

required: type id message country sunrise sunset

required: coord weather base main visibility wind clouds dt sys timezone id name cod


description: Static Analysis Results Format (SARIF) Version 2.1.0-rtm.2 JSON Schema: a standard format for the output of static analysis tools.

enum: analysisTarget attachment responseFile resultFile standardStream tracedFile unmodified modified added deleted renamed uncontrolled driver extension translation taxonomy policy referencedOnCommandLine memoryContents directory userSpecifiedConfiguration toolSpecifiedConfiguration debugOutputFile

format: date-time

required: artifactLocation replacements

format: uri-reference

required: configuration descriptor

required: id sourceNodeId targetNodeId

enum: notApplicable pass fail review open informational


key: address

description: A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).


key: absoluteAddress

description: The address expressed as a byte offset from the start of the addressable region.


key: relativeAddress

description: The address expressed as a byte offset from the absolute address of the top-most parent object.


key: length

description: The number of bytes in this range of addresses.


key: kind

description: An open-ended string that identifies the address kind. 'data', 'function', 'header','instruction', 'module', 'page', 'section', 'segment', 'stack', 'stackFrame', 'table' are well-known values.


key: name

description: A name that is associated with the address, e.g., '.text'.


key: fullyQualifiedName

description: A human-readable fully qualified name that is associated with the address.


key: offsetFromParent

description: The byte offset of this address from the absolute or relative address of the parent object.


key: index

description: The index within run.addresses of the cached object for this address.


key: parentIndex

description: The index within run.addresses of the parent object.


key: properties

description: Key/value pairs that provide additional information about the address.


key: artifact

description: A single artifact. In some cases, this artifact might be nested within another artifact.


key: description

description: A short description of the artifact.


key: location

description: The location of the artifact.


description: Identifies the index of the immediate parent of the artifact, if this artifact is nested.


key: offset

description: The offset in bytes of the artifact within its containing artifact.


description: The length of the artifact in bytes.


key: roles

description: The role or roles played by the artifact in the analysis.


key: mimeType

description: The MIME type (RFC 2045) of the artifact.


key: contents

description: The contents of the artifact.


key: encoding

description: Specifies the encoding for an artifact object that refers to a text file.


key: sourceLanguage

description: Specifies the source language for any artifact object that refers to a text file that contains source code.


key: hashes

description: 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.


key: lastModifiedTimeUtc

description: 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.


description: Key/value pairs that provide additional information about the artifact.


key: artifactChange

description: A change to a single artifact.


key: artifactLocation

description: The location of the artifact to change.


key: replacements

description: An array of replacement objects, each of which represents the replacement of a single region in a single artifact specified by 'artifactLocation'.


description: Key/value pairs that provide additional information about the change.


key: artifactContent

description: Represents the contents of an artifact.


key: text

description: UTF-8-encoded content from a text artifact.


key: binary

description: MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.


key: rendered

description: An alternate rendered representation of the artifact (e.g., a decompiled representation of a binary region).


key: properties

description: Key/value pairs that provide additional information about the artifact content.


description: Specifies the location of an artifact.


key: uri

description: A string containing a valid relative or absolute URI.


key: uriBaseId

description: A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.


key: index

description: The index within the run artifacts array of the artifact object associated with the artifact location.


key: description

description: A short description of the artifact location.


description: Key/value pairs that provide additional information about the artifact location.


key: attachment

description: An artifact relevant to a result.


description: A message describing the role played by the attachment.


description: The location of the attachment.


key: regions

description: An array of regions of interest within the attachment.


key: rectangles

description: An array of rectangles specifying areas of interest within the image.


description: Key/value pairs that provide additional information about the attachment.


key: codeFlow

description: A set of threadFlows which together describe a pattern of code execution relevant to detecting a result.


key: message

description: A message relevant to the code flow.


key: threadFlows

description: An array of one or more unique threadFlow objects, each of which describes the progress of a program through a thread of execution.


description: Key/value pairs that provide additional information about the code flow.


key: configurationOverride

description: Information about how a specific rule or notification was reconfigured at runtime.


key: configuration

description: Specifies how the rule or notification was configured during the scan.


key: descriptor

description: A reference used to locate the descriptor whose configuration was overridden.


description: Key/value pairs that provide additional information about the configuration override.


key: conversion

description: Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.


key: tool

description: A tool object that describes the converter.


key: invocation

description: An invocation object that describes the invocation of the converter.


key: analysisToolLogFiles

description: The locations of the analysis tool's per-run log files.


key: properties

description: Key/value pairs that provide additional information about the conversion.


key: edge

description: Represents a directed edge in a graph.


key: id

description: A string that uniquely identifies the edge within its graph.


key: label

description: A short description of the edge.


key: sourceNodeId

description: Identifies the source node (the node at which the edge starts).


key: targetNodeId

description: Identifies the target node (the node at which the edge ends).


description: Key/value pairs that provide additional information about the edge.


key: edgeTraversal

description: Represents the traversal of a single edge during a graph traversal.


key: edgeId

description: Identifies the edge being traversed.


key: message

description: A message to display to the user as the edge is traversed.


key: finalState

description: The values of relevant expressions after the edge has been traversed.


key: stepOverEdgeCount

description: The number of edge traversals necessary to return from a nested graph.


description: Key/value pairs that provide additional information about the edge traversal.


key: kind

description: A string that identifies the kind of exception, for example, the fully qualified type name of an object that was thrown, or the symbolic name of a signal.


description: A message that describes the exception.


key: stack

description: The sequence of function calls leading to the exception.


key: innerExceptions

description: An array of exception objects each of which is considered a cause of this exception.


description: Key/value pairs that provide additional information about the exception.


key: schema

description: The URI of the JSON schema corresponding to the version of the external property file format.


key: version

description: The SARIF format version of this external properties object.


key: guid

description: A stable, unique identifier for this external properties object, in the form of a GUID.


key: runGuid

description: A stable, unique identifier for the run associated with this external properties object, in the form of a GUID.


key: conversion

description: A conversion object that will be merged with a separate run.


key: graphs

description: An array of graph objects that will be merged with a separate run.


key: externalizedProperties

description: Key/value pairs that provide additional information that will be merged with a separate run.


key: artifacts

description: An array of artifact objects that will be merged with a separate run.


key: invocations

description: Describes the invocation of the analysis tool that will be merged with a separate run.


key: logicalLocations

description: An array of logical locations such as namespaces, types or functions that will be merged with a separate run.


key: threadFlowLocations

description: An array of threadFlowLocation objects that will be merged with a separate run.


key: results

description: An array of result objects that will be merged with a separate run.


key: taxonomies

description: Tool taxonomies that will be merged with a separate run.


key: driver

description: The analysis tool object that will be merged with a separate run.


key: extensions

description: Tool extensions that will be merged with a separate run.


key: policies

description: Tool policies that will be merged with a separate run.


key: translations

description: Tool translations that will be merged with a separate run.


key: addresses

description: Addresses that will be merged with a separate run.


key: webRequests

description: Requests that will be merged with a separate run.


key: webResponses

description: Responses that will be merged with a separate run.


key: properties

description: Key/value pairs that provide additional information about the external properties.


key: location

description: The location of the external property file.


key: guid

description: A stable, unique identifier for the external property file in the form of a GUID.


key: itemCount

description: A non-negative integer specifying the number of items contained in the external property file.


description: Key/value pairs that provide additional information about the external property file.


key: externalPropertyFileReferences

description: References to external property files that should be inlined with the content of a root log file.


key: conversion

description: An external property file containing a run.conversion object to be merged with the root log file.


key: graphs

description: An array of external property files containing a run.graphs object to be merged with the root log file.


key: externalizedProperties

description: An external property file containing a run.properties object to be merged with the root log file.


key: artifacts

description: An array of external property files containing run.artifacts arrays to be merged with the root log file.


key: invocations

description: An array of external property files containing run.invocations arrays to be merged with the root log file.


key: logicalLocations

description: An array of external property files containing run.logicalLocations arrays to be merged with the root log file.


key: threadFlowLocations

description: An array of external property files containing run.threadFlowLocations arrays to be merged with the root log file.


key: results

description: An array of external property files containing run.results arrays to be merged with the root log file.


key: taxonomies

description: An array of external property files containing run.taxonomies arrays to be merged with the root log file.


key: addresses

description: An array of external property files containing run.addresses arrays to be merged with the root log file.


key: driver

description: An external property file containing a run.driver object to be merged with the root log file.


key: extensions

description: An array of external property files containing run.extensions arrays to be merged with the root log file.


key: policies

description: An array of external property files containing run.policies arrays to be merged with the root log file.


key: translations

description: An array of external property files containing run.translations arrays to be merged with the root log file.


key: webRequests

description: An array of external property files containing run.requests arrays to be merged with the root log file.


key: webResponses

description: An array of external property files containing run.responses arrays to be merged with the root log file.


key: properties

description: Key/value pairs that provide additional information about the external property files.


key: fix

description: A proposed fix for the problem represented by a result object. A fix specifies a set of artifacts to modify. For each artifact, it specifies a set of bytes to remove, and provides a set of new bytes to replace them.


key: description

description: A message that describes the proposed fix, enabling viewers to present the proposed change to an end user.


key: artifactChanges

description: One or more artifact changes that comprise a fix for a result.


description: Key/value pairs that provide additional information about the fix.


key: graph

description: A network of nodes and directed edges that describes some aspect of the structure of the code (for example, a call graph).


description: A description of the graph.


key: nodes

description: An array of node objects representing the nodes of the graph.


key: edges

description: An array of edge objects representing the edges of the graph.


description: Key/value pairs that provide additional information about the graph.


key: graphTraversal

description: Represents a path through a graph.


key: runGraphIndex

description: The index within the run.graphs to be associated with the result.


key: resultGraphIndex

description: The index within the result.graphs to be associated with the result.


description: A description of this graph traversal.


key: initialState

description: Values of relevant expressions at the start of the graph traversal that may change during graph traversal.


key: immutableState

description: Values of relevant expressions at the start of the graph traversal that remain constant for the graph traversal.


key: edgeTraversals

description: The sequences of edges traversed by this graph traversal.


description: Key/value pairs that provide additional information about the graph traversal.


key: invocation

description: The runtime environment of the analysis tool run.


key: commandLine

description: The command line used to invoke the tool.


key: arguments

description: An array of strings, containing in order the command line arguments passed to the tool from the operating system.


key: responseFiles

description: The locations of any response files specified on the tool's command line.


key: startTimeUtc

description: The Coordinated Universal Time (UTC) date and time at which the run started. See "Date/time properties" in the SARIF spec for the required format.


key: endTimeUtc

description: The Coordinated Universal Time (UTC) date and time at which the run ended. See "Date/time properties" in the SARIF spec for the required format.


key: exitCode

description: The process exit code.


key: ruleConfigurationOverrides

description: An array of configurationOverride objects that describe rules related runtime overrides.


key: notificationConfigurationOverrides

description: An array of configurationOverride objects that describe notifications related runtime overrides.


key: toolExecutionNotifications

description: A list of runtime conditions detected by the tool during the analysis.


key: toolConfigurationNotifications

description: A list of conditions detected by the tool that are relevant to the tool's configuration.


key: exitCodeDescription

description: The reason for the process exit.


key: exitSignalName

description: The name of the signal that caused the process to exit.


key: exitSignalNumber

description: The numeric value of the signal that caused the process to exit.


key: processStartFailureMessage

description: The reason given by the operating system that the process failed to start.


key: executionSuccessful

description: Specifies whether the tool's execution completed successfully.


key: machine

description: The machine that hosted the analysis tool run.


key: account

description: The account that ran the analysis tool.


key: processId

description: The process id for the analysis tool run.


key: executableLocation

description: An absolute URI specifying the location of the analysis tool's executable.


key: workingDirectory

description: The working directory for the analysis tool run.


key: environmentVariables

description: The environment variables associated with the analysis tool process, expressed as key/value pairs.


key: stdin

description: A file containing the standard input stream to the process that was invoked.


key: stdout

description: A file containing the standard output stream from the process that was invoked.


key: stderr

description: A file containing the standard error stream from the process that was invoked.


key: stdoutStderr

description: A file containing the interleaved standard output and standard error stream from the process that was invoked.


key: properties

description: Key/value pairs that provide additional information about the invocation.


key: location

description: A location within a programming artifact.


key: id

description: Value that distinguishes this location from all other locations within a single result object.


key: physicalLocation

description: Identifies the artifact and region.


key: logicalLocations

description: The logical locations associated with the result.


key: message

description: A message relevant to the location.


key: annotations

description: A set of regions relevant to the location.


key: relationships

description: An array of objects that describe relationships between this location and others.


description: Key/value pairs that provide additional information about the location.


key: locationRelationship

description: Information about the relation of one location to another.


key: target

description: A reference to the related location.


key: kinds

description: A set of distinct strings that categorize the relationship. Well-known kinds include 'includes', 'isIncludedBy' and 'relevant'.


key: description

description: A description of the location relationship.


description: Key/value pairs that provide additional information about the location relationship.


key: logicalLocation

description: A logical location of a construct that produced a result.


key: name

description: Identifies the construct in which the result occurred. For example, this property might contain the name of a class or a method.


key: index

description: The index within the logical locations array.


key: fullyQualifiedName

description: The human-readable fully qualified name of the logical location.


key: decoratedName

description: The machine-readable name for the logical location, such as a mangled function name provided by a C++ compiler that encodes calling convention, return type and other details along with the function name.


key: parentIndex

description: Identifies the index of the immediate parent of the construct in which the result was detected. For example, this property might point to a logical location that represents the namespace that holds a type.


key: kind

description: The type of construct this logical location component refers to. Should be one of 'function', 'member', 'module', 'namespace', 'parameter', 'resource', 'returnType', 'type', 'variable', 'object', 'array', 'property', 'value', 'element', 'text', 'attribute', 'comment', 'declaration', 'dtd' or 'processingInstruction', if any of those accurately describe the construct.


key: properties

description: Key/value pairs that provide additional information about the logical location.


description: Encapsulates a message intended to be read by the end user.


key: text

description: A plain text message string.


key: markdown

description: A Markdown message string.


key: id

description: The identifier for this message.


key: arguments

description: An array of strings to substitute into the message string.


description: Key/value pairs that provide additional information about the message.


key: multiformatMessageString

description: A message string or message format string rendered in multiple formats.


description: A plain text message string or format string.


description: A Markdown message string or format string.


key: node

description: Represents a node in a graph.


description: A string that uniquely identifies the node within its graph.


key: label

description: A short description of the node.


key: location

description: A code location associated with the node.


key: children

description: Array of child nodes.


description: Key/value pairs that provide additional information about the node.


key: notification

description: Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.

default: warning

enum: none note warning error


key: locations

description: The locations relevant to this notification.


key: message

description: A message that describes the condition that was encountered.


key: level

description: A value specifying the severity level of the notification.


key: threadId

description: The thread identifier of the code that generated the notification.


key: timeUtc

description: The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.


key: exception

description: The runtime exception, if any, relevant to this notification.


key: descriptor

description: A reference used to locate the descriptor relevant to this notification.


key: associatedRule

description: A reference used to locate the rule descriptor associated with this notification.


key: properties

description: Key/value pairs that provide additional information about the notification.


key: physicalLocation

description: A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.


key: address

description: The address of the location.


key: artifactLocation

description: The location of the artifact.


key: region

description: Specifies a portion of the artifact.


key: contextRegion

description: Specifies a portion of the artifact that encloses the region. Allows a viewer to display additional context around the region.


description: Key/value pairs that provide additional information about the physical location.


key: propertyBag

description: Key/value pairs that provide additional information about the object.


key: tags

description: A set of distinct strings that provide additional information.


key: rectangle

description: An area within an image.


key: top

description: The Y coordinate of the top edge of the rectangle, measured in the image's natural units.


key: left

description: The X coordinate of the left edge of the rectangle, measured in the image's natural units.


key: bottom

description: The Y coordinate of the bottom edge of the rectangle, measured in the image's natural units.


key: right

description: The X coordinate of the right edge of the rectangle, measured in the image's natural units.


key: message

description: A message relevant to the rectangle.


description: Key/value pairs that provide additional information about the rectangle.


description: A region within an artifact where a result was detected.


key: startLine

description: The line number of the first character in the region.


key: startColumn

description: The column number of the first character in the region.


key: endLine

description: The line number of the last character in the region.


key: endColumn

description: The column number of the character following the end of the region.


key: charOffset

description: The zero-based offset from the beginning of the artifact of the first character in the region.


key: charLength

description: The length of the region in characters.


key: byteOffset

description: The zero-based offset from the beginning of the artifact of the first byte in the region.


key: byteLength

description: The length of the region in bytes.


key: snippet

description: The portion of the artifact contents within the specified region.


description: A message relevant to the region.


key: sourceLanguage

description: Specifies the source language, if any, of the portion of the artifact specified by the region object.


key: properties

description: Key/value pairs that provide additional information about the region.


key: replacement

description: The replacement of a single region of an artifact.


key: deletedRegion

description: The region of the artifact to delete.


key: insertedContent

description: The content to insert at the location specified by the 'deletedRegion' property.


description: Key/value pairs that provide additional information about the replacement.


key: reportingDescriptor

description: Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.


key: id

description: A stable, opaque identifier for the report.


key: deprecatedIds

description: An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool.


key: guid

description: A unique identifier for the reporting descriptor in the form of a GUID.


key: deprecatedGuids

description: An array of unique identifies in the form of a GUID by which this report was known in some previous version of the analysis tool.


key: name

description: A report identifier that is understandable to an end user.