lgtm.json

title: Query

title: ID

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

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

title: Tags

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

title: Tag

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

title: Path Classifiers

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

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

type: string object

title: Exclude

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

title: Queries

title: Query

title: Exclude

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

$ref: #/definitions/queryItem

title: Include

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

title: Extraction

title: Prepare

description: Customizable step used by all languages.

title: Packages

description: One or more packages to install.

title: Package

title: After Prepare

title: Before Index

title: Index

title: All Solutions

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

title: Build Command

type: array string

title: Buildless

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

title: .NET

title: Arguments

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

title: Argument

title: Version

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

title: Exclude

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

title: Filetypes

description: Specify additional file types to extract.

title: Gradle

title: Version

type: string number

title: Include

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

title: Java Version

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

title: Maven

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

title: Settings File

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

title: Toolchains File

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

title: Version

description: Specify the required Maven version.

title: MSBuild

title: Arguments

description: Specify a list of additional arguments to MSBuild.

title: Argument

title: Configuration

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

title: Platform

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

title: Target

description: Specify the MSBuild target.

default: rebuild

title: NuGet Restore

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

title: Properties Files

description: Specify whether .properties files are extracted.

title: Solution

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

title: TypeScript

description: pecify how TypeScript files should be extracted.

enum: none basic full

default: full

title: XML Mode

description: Specify how XML files should be extracted.

enum: all default disabled

title: Configure

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

title: Command

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

title: Python Setup

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.

title: Exclude Requirements

description: Specify packages to exclude from extraction/analysis.

title: Package

title: Requirements

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

title: Package

title: Requirement Files

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

title: Setup Python

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

title: Version

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


pulumi.json

title: PluginOptions

type: object

required: name path

type: string

description: Name of the plugin

description: Path to the plugin folder

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

title: SimpleConfigType

enum: string integer boolean array

$ref: #/$defs/simpleConfigType

$ref: #/$defs/configItemsType

const: array

title: ConfigTypeDeclaration

type: boolean

description: A schema for Pulumi project files.

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

description: Description of the project.

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

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

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

title: ProjectRuntimeInfo

title: Name

title: Name

title: Options

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

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.

description: If true this configuration value should be encrypted.

type: integer

type: array

$ref: #/$defs/configTypeDeclaration

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

description: Backend of the project.

description: URL is optional field to explicitly set backend url

description: Additional project options.

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

const: always

title: ProjectTemplate

description: ProjectTemplate is a Pulumi project template manifest.

description: Description of the template.

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

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.

description: Default value of the config.

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

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

description: Plugins for resource providers.

$ref: #/$defs/pluginOptions

description: Plugins for policy analyzers.

description: Plugins for languages.

required: name runtime

title: Pulumi Project


mta.json

enum: str int float bool

default: str

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.

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

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

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

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

$ref: #/definitions/hooks-parameters

description: Additional information about the hook's parameters.

$ref: #/definitions/properties-metadata

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.

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

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

$ref: #/definitions/generic-memory

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

description: MTA DESCRIPTOR SCHEMA

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

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

description: A free text describing this application.

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

description: The provider or vendor of this application.

description: A copyright statement from the provider.

description: A list of modules.

required: name type

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.

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

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

$ref: #/definitions/properties

description: Additional information about the module's properties.

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

$ref: #/definitions/parameters

description: Additional information about the module's parameters.

$ref: #/definitions/parameters-metadata

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

$ref: #/definitions/hooks

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

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.

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.

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.

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.

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.

description: Additional information about the modules's parameters.

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.

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

description: A free text describing this resource.

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

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

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

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.

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.

title: com.sap.mta.mta-schema_3.3


jfrog-pipelines.json

$ref: #/definitions/JFrog-Pipelines

title: JFrog-Pipelines

$ref: #/definitions/Resource

$ref: #/definitions/Pipeline

title: Resource

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

$ref: #/definitions/resourceTypes/Aql

$ref: #/definitions/resourceTypes/BuildInfo

$ref: #/definitions/resourceTypes/CronTrigger

$ref: #/definitions/resourceTypes/FileSpec

$ref: #/definitions/resourceTypes/GitRepo

$ref: #/definitions/resourceTypes/HelmChart

$ref: #/definitions/resourceTypes/Image

$ref: #/definitions/resourceTypes/PropertyBag

$ref: #/definitions/resourceTypes/RemoteFile

$ref: #/definitions/resourceTypes/VmCluster

required: query sourceArtifactory

required: name type configuration

type: integer string

required: buildName buildNumber

required: serviceName cityName siteName countryCodes sourceDistribution

type: boolean string

enum: ssh https

required: sourceArtifactory repository chart version

title: Pipeline

title: 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

enum: success failure error cancelled skipped unstable timeout stopped deleted cached

required: blueReferenceName greenReferenceName idleName liveName

required: namespace blueReleaseName greenReleaseName roleServices


io-package.json

description: JSON schema for validation

required: name version platform titleLang news desc mode

description: Contains all common instance attributes

description: Name of the adapter without ioBroker

description: Current adapter version

description: Platform, normally Javascript/Node.js

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

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

$ref: #/definitions/multilingual

description: Short form of changelog in all supported languages

description: Description, object for multilingual description

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

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

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

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

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`)

type: number

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

description: Url of the ReadMe file

description: Type of the admin UI

description: UI type of custom tab inside admin UI

const: json

description: UI type of config page inside admin UI

enum: html json materialize none

description: UI type of tab inside admin UI

enum: html materialize

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

type: string array

description: Array of authors as string

description: License of the software

description: Type of the adapter

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

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

description: ioBroker plugins to be used

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.

required: name path width align

enum: left right center justify

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

required: fa-icon link name

description: Font-Awesome icon name for TAB

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

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.

description: Name of TAB (multilingual object) in admin

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

description: Only used by js-controller

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.

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

enum: none daemon subscribe schedule once extension

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

description: Type of connection to device

enum: none local cloud

description: If compact mode supported

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

description: How the data will be received from device

enum: none poll push assumption

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

type: object string

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

description: erase all previous data in the directory before upload

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

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

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

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

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

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

description: Default Loglevel after instance creation

enum: silly debug info warn error

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

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

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

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

description: Execution mode of the adapter

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

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

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

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

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

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

description: OS packages which should be installed on adapter installation

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

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}.

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

description: CRON schedule to restart mode daemon adapters

description: CRON schedule if adapter runs in mode schedule

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}]}

description: Adapter can be installed only once on one host

description: Adapter can be installed only once in whole system

description: If adapter must be stopped before update

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

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

description: Name of variable, that is subscribed automatically

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

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`)

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

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

description: Translation for the widget

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

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

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

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.

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

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

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.

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

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

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"]

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"]

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

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.

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

description: Message will only be shown if condition matches

description: Operand to connect multiple rules

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

description: Title of the shown message

description: Text of the shown message

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

description: The importance of the message

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

description: Predefined buttons of the message window

description: Objects which will be created for the adapter

description: Objects which will be created for each instance

description: Register notifications for the built-in notification system

description: Name which will be shown to the user

description: Description which will be shown to the user

required: category name severity description regex limit

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

description: Maximum amount of notifications to collect of this type

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

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

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"]


title: CrowdSec Scenario

$ref: #/$defs/leaky

$ref: #/$defs/counter

$ref: #/$defs/trigger

$ref: #/$defs/conditional

required: type name leakspeed description

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.

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.

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

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).

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

$ref: #/$defs/data

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:
An expr expression that must return a string. This string will
be used as a partition for the buckets.

$ref: #/$defs/labels

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: Make the bucket overflow when it returns true. The expression is evaluated each time an event is poured to the bucket.

required: type name leakspeed description condition

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

required: type name description

required: type name duration description

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.

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


hayson-json-schema.json

$ref: #/definitions/hval

$ref: #/definitions/gridMeta

$ref: #/definitions/gridColumn

$ref: #/definitions/dict

$ref: #/definitions/marker

$ref: #/definitions/remove

$ref: #/definitions/na

$ref: #/definitions/number

$ref: #/definitions/numberSpecial

$ref: #/definitions/symbol

$ref: #/definitions/ref

$ref: #/definitions/uri

$ref: #/definitions/date

$ref: #/definitions/time

$ref: #/definitions/dateTime

$ref: #/definitions/list

$ref: #/definitions/grid

$ref: #/definitions/coord

$ref: #/definitions/xstr

enum: INF -INF NaN

format: date

required: _kind lat lng

required: _kind type val


chutzpah.json

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

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

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

description: Determines if the web server mode is enabled.

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

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.

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

enum: Raw Script

default: Raw

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

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

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.

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

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

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.

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.

$ref: #/definitions/templateOptions

description: The source file/directory

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

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

description: The name of the transform to execute

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

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.

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

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.

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

$ref: #/definitions/compilePathMap

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

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.

description: The arguments to pass to the command.

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

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.

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.

enum: Executable External

default: External

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

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

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

enum: qunit jasmine mocha

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.

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.

$ref: #/definitions/referenceSettings

$ref: #/definitions/testSettings

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

$ref: #/definitions/engineOptions

$ref: #/definitions/serverSettings

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

$ref: #/definitions/transformConfig

$ref: #/definitions/compileSettings

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

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.

enum: Normal AMD

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

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

enum: DriveRoot SettingsFileDirectory

default: DriveRoot

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

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

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

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

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

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.

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

enum: bdd tdd qunit

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

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.

description: The user agent to use when making web requests

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

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.

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.

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

description: Logs tracing information to a log file.

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

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

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

title: JSON schema for Chutzpah test runner settings files


repository-configuration-schema.json

title: ORT repository configuration

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.

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

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

$ref: #/definitions/pathExcludeReason

required: pattern reason

$ref: #/definitions/scopeExcludeReason

description: Curations for artifacts in a repository.

$ref: #/definitions/licenseFindingCurations

description: A configuration for a specific package and provenance.

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

required: path concluded_license reason


vercel.json

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

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

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

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 `@`

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

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

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 `**`

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

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.

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

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`).

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.

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.

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).

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

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

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

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

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

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

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

description: A list of header definitions.

required: source headers

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

required: key value

description: An array of requirements that are needed to match

required: type value

description: The type of request element to check

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

required: type key

description: The type of request element to check

enum: header cookie query

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

description: The type of request element to check

description: The type of request element to check

enum: inline attachment

enum: image/avif image/webp image/jpeg image/png

enum: http https

description: A name for the deployment

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

title: Redirects

description: A list of redirect definitions.

required: source destination

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

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

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

description: The type of request element to check

description: The type of request element to check

description: The type of request element to check

description: The type of request element to check

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

description: A list of rewrite definitions.

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

description: The type of request element to check

description: The type of request element to check

description: The type of request element to check

description: The type of request element to check

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

description: The type of request element to check

description: The type of request element to check

description: The type of request element to check

description: The type of request element to check

enum: error filesystem hit miss resource rewrite

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

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.

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

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

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

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

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

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


workflows.json

description: A subworkflow.

description: The name of the parameter variable.

description: An array of objects with a single step.

$ref: #/definitions/stepArray

description: An array of objects with a single step.

description: An object with a single step.

description: A single workflow step.

$ref: #/definitions/step

description: A single workflow step.

$ref: #/definitions/assign

$ref: #/definitions/call

$ref: #/definitions/args

$ref: #/definitions/result

$ref: #/definitions/next

$ref: #/definitions/switch

$ref: #/definitions/for

$ref: #/definitions/parallel

$ref: #/definitions/raise

$ref: #/definitions/try

$ref: #/definitions/retry

$ref: #/definitions/except

$ref: #/definitions/return

description: A list of variable assignment maps.

description: A single variable assignment.

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.

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

format: uri

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

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

enum: GET HEAD POST PUT DELETE CONNECT OPTIONS TRACE PATCH

description: Header fields to supply input to the API.

description: Body fields to supply input to the API.

description: Query fields to supply input to the API.

description: Required if the API being called requires authentication.

description: The type of authentication.

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

description: List of scope strings.

description: Scope string.

$ref: #/definitions/scopes

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.

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.

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.

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

description: Define what step Workflows should execute next.

description: The step name.

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

const: end

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

const: continue

description: Terminate iteration of a for loop.

const: break

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

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

required: value steps

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

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

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.

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}]).

description: Each iteration the steps will be executed.

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.

const: continueAll

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.

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

$ref: #/definitions/branches

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.

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.

$ref: #/definitions/condition

description: Define conditional expressions for a switch block.

description: An expression to switch on.

description: Raise an exception.

description: Error message string.

description: Error message map.

description: Error code.

description: Error message string.

description: A try/except structure for error handling.

description: A step.

description: A list of steps.

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

description: A list of steps.

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

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

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.

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.

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}.

description: List of scope strings.

description: Scope string.

description: Space and comma-separated strings

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

description: The main workflow.

description: The name of the parameter variable.

description: An array of objects with a single step.

description: A list of steps.

title: Google Cloud Workflows


openweather.current.json

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

title: OpenWeather Current Weather Data API