required: name path

type: object

type: string

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

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

type: array

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

key: includes


default: str

enum: str int float bool

type: boolean

key: properties-metadata


description: If true, all generate commands will generate a flat structure

key: GenerateFlatOptions


description: (Swagger Only) DTO (Data Transfer Object) files suffix. Default value: ['.dto.ts', '.entity.ts']. See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details

description: (Swagger Only) If set to true, the module will reuse class-validator validation decorators (e.g. @Max(10) will add max: 10 to schema definition). See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details

description: (Swagger Only) Controller files suffix. See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details

default: description

description: (Swagger Only) The property key to set the comment text to on ApiProperty. See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details

description: (Swagger Only) The property key to set the comment text to on ApiOperation. See https://docs.nestjs.com/openapi/cli-plugin#using-the-cli-plugin for details

key: SwaggerPluginOptions


type: boolean object

description: If the value is boolean, a value of true enables spec generation by default and a value of false disables it. A flag passed on the CLI command line overrides this setting, as does a project-specific generateOptions setting (more below). If the value is an object, each key represents a schematic name, and the boolean value determines whether the default spec generation is enabled / disabled for that specific schematic. See https://docs.nestjs.com/cli/monorepo#global-generate-options for details.

description: Alias for guard

description: Alias for controller

description: Alias for class

description: Alias for sub-app

description: Generate spec file for module schematics or not.

description: Generate spec file for guard schematics or not.

description: Alias for gateway

description: Alias for interceptor

description: Generate spec file for interceptor schematics or not.

description: Generate spec file for gateway schematics or not.

description: Alias for provider

description: Generate spec file for pipe schematics or not.

description: Generate spec file for service schematics or not.

description: Alias for resource

description: Generate spec file for application schematics or not.

description: Generate spec file for provider schematics or not.

description: Alias for pipe

description: Alias for configuration

description: Generate spec file for controller schematics or not.

description: Generate spec file for library schematics or not.

description: Generate spec file for resolver schematics or not.

description: Generate spec file for interface schematics or not.

description: Generate spec file for configuration schematics or not.

description: Disable spec file generation for class schematics.

description: Generate spec file for decorator schematics or not.

description: Alias for library

description: Generate spec file for sub-app schematics or not.

description: Generate spec file for resource schematics or not.

description: Alias fro decorator

description: Alias for filter

description: Generate spec file for middleware schematics or not.

description: Alias for middleware

description: Generate spec file for filter schematics or not.

description: Alias for resolver

description: Alias for resolver

description: Alias for module

key: GenerateSpecOptions


description: Base directory

key: GenerateBaseDirOptions


description: If set to true, plugin will generate descriptions and example values for properties based on comments.

key: PluginOptions


description: (GraphQL Only) GraphQL types files suffix. Default value: ['.input.ts', '.args.ts', '.entity.ts', '.model.ts']. See https://docs.nestjs.com/graphql/cli-plugin#using-the-cli-plugin for details.

key: GraphQLPluginOptions


type: string object

description: For finer control, the element can be object.

description: Glob-like file specifications for the assets to be excluded from the include list.

description: Glob-like file specifications for the assets to be distributed.

description: If true, run in watch mode watching specified assets. Setting watchAssets in a top-level compilerOptions property overrides any watchAssets settings within the assets property.

description: A string specifying the path (relative to the root folder) where the assets should be distributed. Defaults to the same output directory configured for compiler output.

key: AssetsOptions


title: Drupal configuration

required: breakpointsPath themeName

key: drupal


enum: module commonjs

title: JavaScript configuration

key: js


title: Prettier options

key: prettier


title: Toggle available extraction options

key: options


title: CSS configuration

key: css


description: Server generated file identifier to be used for retrieving file metadata and download URL.

title: Update file id

key: fileId


description: Options for the [machine executor](https://circleci.com/docs/configuration-reference#machine)

default: true

description: Set to `true` to enable [Docker Layer Caching](https://circleci.com/docs/docker-layer-caching). Note: If you haven't already, you must open a support ticket to have a CircleCI Sales representative contact you about enabling this feature on your account for an additional fee.

description: The VM image to use. View [available images](https://circleci.com/docs/configuration-reference#available-machine-images). **Note:** This key is **not** supported on the installable CircleCI. For information about customizing machine executor images on CircleCI installed on your servers, see our [VM Service documentation](https://circleci.com/docs/vm-service).

key: machineExecutor


description: The name the container is reachable by. By default, container services are accessible through `localhost`

description: The name of a custom docker image to use

description: Authentication for AWS EC2 Container Registry (ECR)

description: Authentication for registries using standard `docker login` credentials

type: string number boolean

description: A map of environment variable names and values

description: The command used as pid 1 (or args for entrypoint) when launching the container

description: Which user to run the command as

description: The command used as executable when launching the container

description: Options for the [docker executor](https://circleci.com/docs/configuration-reference#docker)

key: dockerExecutor


description: A map defining rules for execution on specific branches

description: Either a single branch specifier, or a list of branch specifiers

key: filter


description: Options for the [macOS executor](https://circleci.com/docs/configuration-reference#macos)

type: number

description: The version of Xcode that is installed on the virtual machine, see the [Supported Xcode Versions section of the Testing iOS](https://circleci.com/docs/testing-ios#supported-xcode-versions) document for the complete list.

key: macosExecutor


key: nodeTypeOpenstackVolumeInterfaces


get_property: SELF sources

get_attribute: SELF timeout

key: ansiblePlaybookInputs


key: cloudifyGetAttribute


key: nodeTypeOpenstackUserInterfaces


description:
Indicate whether the resource exists or if Cloudify should create the resource,
true if you are bringing an existing resource, false if you want cloudify to create it.

key: gcpExternalResource


key: cloudifyGetProperty


description: A dictionary of keys and values that is not validated but will override other values in the resource config.

key: openstackDataTypeKwargs


get_attribute: SELF name

get_property: SELF scopes

get_property: SELF name

get_property: SELF zone

get_property: SELF tags

get_attribute: SELF zone


key: nodeTypeCloudifyTerminalRawInterfaces


key: nodeTypeOpenstackPortInterfaces


key: nodeTypeDockerContainersInterfaces


key: cloudifyDatatypesHelmSetFlagsList


required: nextHopType addressPrefix

description: See https://msdn.microsoft.com/en-us/library/mt459110.aspx


key: nodeTypeDockerContainerFilesInterfaces


key: nodeTypeDockerContainerInterfaces


description: See https://msdn.microsoft.com/en-us/library/mt163661.aspx


key: nodeTypeOpenstackGroupInterfaces


key: nodeTypeOpenstackVolumeTypeInterfaces


type: integer

key: nodeTypeDockerAnsiblePlaybookInterfaces


key: nodeTypeOpenstackRoleInterfaces


key: nodeTypeCloudifyGCPProjectInterfaces


description: Schema of inputs to be passed to the implementation as kwargs.

description: Number of seconds to wait before the operation is terminated by the orchestrator. A value of 0 (or no value at all, which is the default) means no timeout.

description: The script or plugin task name to execute.

description: If true (the default), and a timeout occurred, then, the operation will raise a RecoverableError, resulting in the operation being retried. Otherwise, a NonRecoverableError is raised, ending the execution with a failure.

description: Minimum wait time (in seconds) between task retries (Default: task_retry_interval in the Cloudify Manager config.yaml file for remote workflows and task_retry_interval workflow configuration for local workflows).

description: Maximum number of retries for a task. -1 means infinite retries (Default: task_retries in the Cloudify Manager config.yaml file for remote workflows, and task_retries workflow configuration for local workflows).

description: Valid values: central_deployment_agent, host_agent. See the Plugins Specification for more info.

key: nodeTemplateInterfaceAction


key: nodeTypeDockerHostDetailsInterfaces


key: nodeTypeOpenstackProjectInterfaces


description: See https://msdn.microsoft.com/en-us/library/mt163668.aspx


key: nodeTypeDockerTerraformModuleInterfaces


key: nodeTypeDockerImagesInterfaces


key: nodeTypeOpenstackSubnetInterfaces


description:
The AWS resource ID of the external resource, if
use_external_resource is true. Otherwise it is an empty string.

key: awsResourceId


description: Description for the data type.

description: Parent data type.

description: Dictionary of the data type properties.

key: dataType


description: See https://msdn.microsoft.com/en-us/library/mt163574.aspx


key: nodeTypeOpenstackNetworkInterfaces


description: A dictionary of node interfaces.

description: A dictionary of node properties.

description: A string referencing a parent type.

key: nodeType


key: nodeTypeDockerImageInterfaces


key: nodeTypeDockerHostInterfaces


key: nodeTypeCloudifyNodesFileInterfaces


type: number string boolean integer

description: The constraints the input value must comply with. Read more details about the format and usage of the constraints in the Constraints section below.

key: inputPropertyConstraints


key: nodeTypeOpenstackImageInterfaces


type: array object


key: cloudifyGetSecret


description:
URL or path to a ZIP/tar.gz file or a Git repository to obtain
new module source from. If omitted, then the module is reloaded
from its last location.

description:
If true, then the plugin destroys the existing Terraform
topology before applying the new one.

key: nodeTypeTerraformModuleInterfaces


description: See https://msdn.microsoft.com/en-us/library/mt163656.aspx


key: nodeTypeOpenstackZoneInterfaces


description:
Allow the public key material to be stored as a runtime
property. Recommended.

description:
Allow the private key material to be stored as a runtime
property. Not recommended for manager deployments.

key: nodeTypeCloudifyNodesRSAKeyInterfaces


key: nodeTypeOpenstackRecordSetInterfaces


key: nodeTypeOpenstackFloatingIPInterfaces


key: nodeTypeOpenstackKeyPairInterfaces


key: nodeTypeOpenstackFlavorInterfaces


key: nodeTypeOpenstackRouterInterfaces


description:
The GCP resource ID of the external resource, if
use_external_resource is true. Otherwise it is an empty string.

key: gcpResourceId


key: nodeTypeTerraformInterfaces


description: Valid values: all_to_all and all_to_one (See explanation below.)

description: A dictionary of interfaces.

description: Either a newly-declared relationship type or one of the relationship types provided by default when importing the types.yaml file.

description: The name of the node to which the current node is related.

description: A dictionary of interfaces.

key: nodeTemplateRelationship


description: Set to true to enable debugging of SQL scripts and stored procedures.

description: The url to enable debugging on a Blazor WebAssembly application.

description: Set to true to bind the SSL port.

description: The authentication scheme to use when connecting to the remote computer.

description: The relative URL to launch in the browser.

description: The SSL port to use for the web site.

description: Set to true to enable the JavaScript debugger for Microsoft Edge (Chromium) based WebView2.

description: Sets the working directory of the command.

description: The name and port number of the remote machine in name:port format.

description: Set to true to leave the IIS application pool running when the project is closed.

enum: Executable Project IIS IISExpress DebugRoslynComponent Docker DockerCompose MsixPackage

description: Identifies the debug target to run.

description: Set to true to display a message when the project is building.

description: The HTTP port to use for the web site.

description: A relative ot absolute path to the .NET project file on which Roslyn component should be executed. Relative to the current project's folder.

description: Set to true to enable applying code changes to the running application.

description: Set to true to disable configuration of the site when running the Asp.Net Core Project profile.

enum: InProcess OutOfProcess

description: Specifies the hosting model to use when running ASP.NET core projects in IIS and IIS Express.

description: Publish all exposed ports to random ports in Docker (-P).

description: An absolute or relative path to the executable.

description: Set to true to have the debugger attach to a process on a remote computer.

description: Set to true to enable native code debugging.

description: A semi-colon delimited list of URL(s) to configure for the web server.

description: The arguments to pass to the target being run.

description: Set the environment variables as key/value pairs.

description: Set to true if the browser should be launched.

description: Set to true to run the 64 bit version of IIS Express, false to run the x86 version.

key: profileContent


description: The URL of the web site.

format: uri

description: The SSL port to use for the web site.

key: iisBindingContent


description: A string identifier. Used to group multiple recipes together in the recipe book.

description: If a notification is shown when the recipe is unlocked.

description: A namespaced ID indicating the type of serializer of the recipe.

key: tagsCommonToAllRecipes


enum: building redstone equipment misc

description: Category of common recipes (in recipe book).

title: category

key: commonRecipeCategory


enum: food blocks misc

description: Category of cooking recipes (in recipe book).

title: category

key: cookingRecipeCategory


description: An item ID.

description: An item tag.

key: item


description: The amount of the item.

description: An item ID.

description: The output item of the recipe.

title: result

key: result


description:
If using `sfdx-cli` auth, this is the only property needed to authenticate.
Otherwise, supply additional oAuth parameters

key: AuthConfig


required: apiName propName

description: The generated class property name

description: The Target SObject API name

key: FieldMapping


enum: SIMPLE_SCHEMA_NODE_TYPE_UNSPECIFIED 0 STRING 1 BOOLEAN 2 FLOAT 3 INTEGER 4 LONG 5 NODE 10


description: One mapping that contains at least transfer and resource values.

enum: text binary

description: The transfer mode to be used. Can be 'text' or 'binary'.

description: The data set name to be mapped to. Can use a wildcard such as '**CPY'.

description: One member mapping that contains at least transfer and resource values.

description: The data set member name to be mapped to. Can use a wildcard such as '**CPY'.

description: A local file extension such as cbl or pl1.

description: The encoding to be used for text transfer. See the RSE API documentation for the values allowed.

description: A nested mappings array with resource mappings to members of the data sets that were mapped by the parent mapping.

key: rseapiSettingsItemMapping


required: name type locations

default: local

enum: mvs local

description: The type of the property group defining where dependencies should be located. Allowed values are 'local' for using a local workspace and 'mvs' for dependencies located in MVS Datasets.

examples: local mvs

default: syslib

description: Name of the library. The default name should be `syslib` if using unamed libraries.

examples: syslib currencylib

description: An array of include file locations. For 'local' libraries values can be absolute and relative filename paths using GLOB patterns. For 'mvs' libraries value can be data set names. GLOB patterns for dat sets are currently not supported.

key: libraryItem


type: object string

description: A person who has been involved in creating or maintaining this package

format: email

key: person


required: application command

description: DBB build script properties for running User Build on remote host.

description: The full path of build script on the remote host that should be used with the command.

description: Lists of GLOB patterns that define the files that should be downloaded from USS after the build. Relative path names are interpreted relative to the DBB log directory user setting. If not provided then all files of the user setting location will be downloaded.

description: Defines the name of the application to build. Will be used to create a folder on USS to upload all files to.

description: Command that the build script is executed with such as the path to groovyz and it's parameters.

description: A list of strings that are the parameters for the build script. Check the documentation for built-in variables, such as the name of the program to build, that can be used here.

description: Lists of GLOB patterns that define the files that should be uploaded to USS for a build. Relative path names are interpreted relative to the location of the ZAPP file that is being used for the build, which is a ZAPP file in the same workspace as the program to be build.

key: dbbSettingsItem


description: The current directory

const: {{filename}}

description: The filename you pass to nodemon

key: variables


description: Regular expression

key: pathPattern


const: SIGTERM

const: SIGINT

const: SIGQUIT

const: SIGKILL

const: SIGHUP

key: terminationSignals


description: The input varies by tool. For example, the required version number, the package-id, the input source file or source directory.

title: The tool input

description: The name of the tool to run.

title: The tool name

description: Comments for this tool item. For documentation only; ignored by the tool.

title: Comments

description: Additional Options to be appended to the tool's command line.

title: Additional options

key: runObject


enum: Android Editor iOS LinuxStandalone32 LinuxStandalone64 LinuxStandaloneUniversal Lumin macOSStandalone Nintendo3DS PS4 PSVita Stadia Switch tvOS WSA WebGL WindowsStandalone32 WindowsStandalone64 XboxOne

key: platformValues


description: Console command name

title: Command name

key: commands


description: CVar name

title: Variable name

key: cvars


enum: cache source

description: Whether the outputs should be stored in a hidden cache or in the source directory.

key: buildTo


description: To construct a key, you join the package name and the builder name with a colon.

title: An identifier for a builder

key: builderKey


description: A target key has two parts, a package and a name. They are separated by a colon.

title: An identifier for a target

key: targetKey


description: On which packages the builder is applied by default

key: autoApply


description: An arbitrary Map<String, dynamic> of configuration options exposed by the individual builders. See the documentation for the builder you are configuring for guidance.

title: Options to apply to a builder

key: builderOptions


required: as json

title: Capture

key: Capture


title: HTTP

key: HTTP


required: id name

title: Category

key: Category


title: PluginsExpect

key: PluginsExpect


required: accept api_key contentType

title: DeleteHeaders

key: DeleteHeaders


title: ExpectElement

key: ExpectElement


required: Content-Type accept

title: PostHeaders

key: PostHeaders


title: GetHeaders

key: GetHeaders


title: TLS

key: TLS


required: password username

title: Qs

key: Qs


required: arrivalRate duration

title: DevPhase

key: DevPhase


title: MetricsByEndpoint

key: MetricsByEndpoint


required: arrivalRate duration name

title: ConfigPhase

key: ConfigPhase


required: priority send status tags title

title: Event

key: Event


description: A map of environment variables to use when running the task. If specifying raw values, the value may be a string; if using config variables, the value must be an object with config mapped to the name of the config variable.

key: envVars


description: Users to assign the permission to.

description: Groups to assign the permission to.

key: permissionConfig


description: A list of config variables that this task can access.

key: configs


required: slug type

description: A regular expression with which to validate parameter values.

format: regex

description: Whether the parameter is a list parameter or not.

description: A human-readable description of the parameter.

description: The default value of the parameter.

description: Set to false to indicate that this parameter is optional.

description: A JST that's evaluated to validate the parameter value. This should evaluate to a string error message if the validation fails. You can reference the value of other parameters using the `params` object.

examples: params.country.value === 'USA' ? 'The country cannot be set to USA.' : undefined

description: An identifier for the parameter, which can be used in JavaScript templates (https://docs.airplane.dev/runbooks/javascript-templates).

description: A JST that's evaluated to determine whether the parameter is hidden. You can reference the value of other parameters using the `params` object.

enum: shorttext longtext sql boolean upload integer float date datetime configvar json

description: The type of parameter.

required: label value

required: label config

description: A list of options to constrain the parameter values. For configvar types, each option needs to be an object with a label (value to show to user) and a config (name of the config var). For all other types, each option can be a single value or an object with a label and a value.

value: Bruce Wayne

label: Batman

description: The task that's run to populate the options.

description: A JST that's evaluated to determine whether to run the task to populate the options. You can reference the value of other parameters using the `params` object.

description: A human-readable name for the parameter.

key: parameter


enum: mainhand offhand feet legs chest head

key: slotEnum


description: A public URL.

key: URL


description: Flag data.

key: Flags


description: Relative path to a file, case sensitive.

format: uri-reference

key: File


$id: timezone

enum: Africa/Abidjan Africa/Accra Africa/Addis_Ababa Africa/Algiers Africa/Asmara Africa/Asmera Africa/Bamako Africa/Bangui Africa/Banjul Africa/Bissau Africa/Blantyre Africa/Brazzaville Africa/Bujumbura Africa/Cairo Africa/Casablanca Africa/Ceuta Africa/Conakry Africa/Dakar Africa/Dar_es_Salaam Africa/Djibouti Africa/Douala Africa/El_Aaiun Africa/Freetown Africa/Gaborone Africa/Harare Africa/Johannesburg Africa/Juba Africa/Kampala Africa/Khartoum Africa/Kigali Africa/Kinshasa Africa/Lagos Africa/Libreville Africa/Lome Africa/Luanda Africa/Lubumbashi Africa/Lusaka Africa/Malabo Africa/Maputo Africa/Maseru Africa/Mbabane Africa/Mogadishu Africa/Monrovia Africa/Nairobi Africa/Ndjamena Africa/Niamey Africa/Nouakchott Africa/Ouagadougou Africa/Porto-Novo Africa/Sao_Tome Africa/Timbuktu Africa/Tripoli Africa/Tunis Africa/Windhoek America/Adak America/Anchorage America/Anguilla America/Antigua America/Araguaina America/Argentina/Buenos_Aires America/Argentina/Catamarca America/Argentina/ComodRivadavia America/Argentina/Cordoba America/Argentina/Jujuy America/Argentina/La_Rioja America/Argentina/Mendoza America/Argentina/Rio_Gallegos America/Argentina/Salta America/Argentina/San_Juan America/Argentina/San_Luis America/Argentina/Tucuman America/Argentina/Ushuaia America/Aruba America/Asuncion America/Atikokan America/Atka America/Bahia America/Bahia_Banderas America/Barbados America/Belem America/Belize America/Blanc-Sablon America/Boa_Vista America/Bogota America/Boise America/Buenos_Aires America/Cambridge_Bay America/Campo_Grande America/Cancun America/Caracas America/Catamarca America/Cayenne America/Cayman America/Chicago America/Chihuahua America/Coral_Harbour America/Cordoba America/Costa_Rica America/Creston America/Cuiaba America/Curacao America/Danmarkshavn America/Dawson America/Dawson_Creek America/Denver America/Detroit America/Dominica America/Edmonton America/Eirunepe America/El_Salvador America/Ensenada America/Fort_Nelson America/Fort_Wayne America/Fortaleza America/Glace_Bay America/Godthab America/Goose_Bay America/Grand_Turk America/Grenada America/Guadeloupe America/Guatemala America/Guayaquil America/Guyana America/Halifax America/Havana America/Hermosillo America/Indiana/Indianapolis America/Indiana/Knox America/Indiana/Marengo America/Indiana/Petersburg America/Indiana/Tell_City America/Indiana/Vevay America/Indiana/Vincennes America/Indiana/Winamac America/Indianapolis America/Inuvik America/Iqaluit America/Jamaica America/Jujuy America/Juneau America/Kentucky/Louisville America/Kentucky/Monticello America/Knox_IN America/Kralendijk America/La_Paz America/Lima America/Los_Angeles America/Louisville America/Lower_Princes America/Maceio America/Managua America/Manaus America/Marigot America/Martinique America/Matamoros America/Mazatlan America/Mendoza America/Menominee America/Merida America/Metlakatla America/Mexico_City America/Miquelon America/Moncton America/Monterrey America/Montevideo America/Montreal America/Montserrat America/Nassau America/New_York America/Nipigon America/Nome America/Noronha America/North_Dakota/Beulah America/North_Dakota/Center America/North_Dakota/New_Salem America/Nuuk America/Ojinaga America/Panama America/Pangnirtung America/Paramaribo America/Phoenix America/Port-au-Prince America/Port_of_Spain America/Porto_Acre America/Porto_Velho America/Puerto_Rico America/Punta_Arenas America/Rainy_River America/Rankin_Inlet America/Recife America/Regina America/Resolute America/Rio_Branco America/Rosario America/Santa_Isabel America/Santarem America/Santiago America/Santo_Domingo America/Sao_Paulo America/Scoresbysund America/Shiprock America/Sitka America/St_Barthelemy America/St_Johns America/St_Kitts America/St_Lucia America/St_Thomas America/St_Vincent America/Swift_Current America/Tegucigalpa America/Thule America/Thunder_Bay America/Tijuana America/Toronto America/Tortola America/Vancouver America/Virgin America/Whitehorse America/Winnipeg America/Yakutat America/Yellowknife Antarctica/Casey Antarctica/Davis Antarctica/DumontDUrville Antarctica/Macquarie Antarctica/Mawson Antarctica/McMurdo Antarctica/Palmer Antarctica/Rothera Antarctica/South_Pole Antarctica/Syowa Antarctica/Troll Antarctica/Vostok Arctic/Longyearbyen Asia/Aden Asia/Almaty Asia/Amman Asia/Anadyr Asia/Aqtau Asia/Aqtobe Asia/Ashgabat Asia/Ashkhabad Asia/Atyrau Asia/Baghdad Asia/Bahrain Asia/Baku Asia/Bangkok Asia/Barnaul Asia/Beirut Asia/Bishkek Asia/Brunei Asia/Calcutta Asia/Chita Asia/Choibalsan Asia/Chongqing Asia/Chungking Asia/Colombo Asia/Dacca Asia/Damascus Asia/Dhaka Asia/Dili Asia/Dubai Asia/Dushanbe Asia/Famagusta Asia/Gaza Asia/Harbin Asia/Hebron Asia/Ho_Chi_Minh Asia/Hong_Kong Asia/Hovd Asia/Irkutsk Asia/Istanbul Asia/Jakarta Asia/Jayapura Asia/Jerusalem Asia/Kabul Asia/Kamchatka Asia/Karachi Asia/Kashgar Asia/Kathmandu Asia/Katmandu Asia/Khandyga Asia/Kolkata Asia/Krasnoyarsk Asia/Kuala_Lumpur Asia/Kuching Asia/Kuwait Asia/Macao Asia/Macau Asia/Magadan Asia/Makassar Asia/Manila Asia/Muscat Asia/Nicosia Asia/Novokuznetsk Asia/Novosibirsk Asia/Omsk Asia/Oral Asia/Phnom_Penh Asia/Pontianak Asia/Pyongyang Asia/Qatar Asia/Qostanay Asia/Qyzylorda Asia/Rangoon Asia/Riyadh Asia/Saigon Asia/Sakhalin Asia/Samarkand Asia/Seoul Asia/Shanghai Asia/Singapore Asia/Srednekolymsk Asia/Taipei Asia/Tashkent Asia/Tbilisi Asia/Tehran Asia/Tel_Aviv Asia/Thimbu Asia/Thimphu Asia/Tokyo Asia/Tomsk Asia/Ujung_Pandang Asia/Ulaanbaatar Asia/Ulan_Bator Asia/Urumqi Asia/Ust-Nera Asia/Vientiane Asia/Vladivostok Asia/Yakutsk Asia/Yangon Asia/Yekaterinburg Asia/Yerevan Atlantic/Azores Atlantic/Bermuda Atlantic/Canary Atlantic/Cape_Verde Atlantic/Faeroe Atlantic/Faroe Atlantic/Jan_Mayen Atlantic/Madeira Atlantic/Reykjavik Atlantic/South_Georgia Atlantic/St_Helena Atlantic/Stanley Australia/ACT Australia/Adelaide Australia/Brisbane Australia/Broken_Hill Australia/Canberra Australia/Currie Australia/Darwin Australia/Eucla Australia/Hobart Australia/LHI Australia/Lindeman Australia/Lord_Howe Australia/Melbourne Australia/North Australia/NSW Australia/Perth Australia/Queensland Australia/South Australia/Sydney Australia/Tasmania Australia/Victoria Australia/West Australia/Yancowinna Brazil/Acre Brazil/DeNoronha Brazil/East Brazil/West Canada/Atlantic Canada/Central Canada/Eastern Canada/Mountain Canada/Newfoundland Canada/Pacific Canada/Saskatchewan Canada/Yukon Chile/Continental Chile/EasterIsland Cuba Egypt Eire Etc/GMT Etc/GMT+0 Etc/GMT+1 Etc/GMT+10 Etc/GMT+11 Etc/GMT+12 Etc/GMT+2 Etc/GMT+3 Etc/GMT+4 Etc/GMT+5 Etc/GMT+6 Etc/GMT+7 Etc/GMT+8 Etc/GMT+9 Etc/GMT-0 Etc/GMT-1 Etc/GMT-10 Etc/GMT-11 Etc/GMT-12 Etc/GMT-13 Etc/GMT-14 Etc/GMT-2 Etc/GMT-3 Etc/GMT-4 Etc/GMT-5 Etc/GMT-6 Etc/GMT-7 Etc/GMT-8 Etc/GMT-9 Etc/GMT0 Etc/Greenwich Etc/UCT Etc/Universal Etc/UTC Etc/Zulu Europe/Amsterdam Europe/Andorra Europe/Astrakhan Europe/Athens Europe/Belfast Europe/Belgrade Europe/Berlin Europe/Bratislava Europe/Brussels Europe/Bucharest Europe/Budapest Europe/Busingen Europe/Chisinau Europe/Copenhagen Europe/Dublin Europe/Gibraltar Europe/Guernsey Europe/Helsinki Europe/Isle_of_Man Europe/Istanbul Europe/Jersey Europe/Kaliningrad Europe/Kiev Europe/Kirov Europe/Lisbon Europe/Ljubljana Europe/London Europe/Luxembourg Europe/Madrid Europe/Malta Europe/Mariehamn Europe/Minsk Europe/Monaco Europe/Moscow Europe/Nicosia Europe/Oslo Europe/Paris Europe/Podgorica Europe/Prague Europe/Riga Europe/Rome Europe/Samara Europe/San_Marino Europe/Sarajevo Europe/Saratov Europe/Simferopol Europe/Skopje Europe/Sofia Europe/Stockholm Europe/Tallinn Europe/Tirane Europe/Tiraspol Europe/Ulyanovsk Europe/Uzhgorod Europe/Vaduz Europe/Vatican Europe/Vienna Europe/Vilnius Europe/Volgograd Europe/Warsaw Europe/Zagreb Europe/Zaporozhye Europe/Zurich GB GB-Eire Hongkong Iceland Indian/Antananarivo Indian/Chagos Indian/Christmas Indian/Cocos Indian/Comoro Indian/Kerguelen Indian/Mahe Indian/Maldives Indian/Mauritius Indian/Mayotte Indian/Reunion Iran Israel Jamaica Japan Kwajalein Libya Mexico/BajaNorte Mexico/BajaSur Mexico/General Navajo NZ NZ-CHAT Pacific/Apia Pacific/Auckland Pacific/Bougainville Pacific/Chatham Pacific/Chuuk Pacific/Easter Pacific/Efate Pacific/Enderbury Pacific/Fakaofo Pacific/Fiji Pacific/Funafuti Pacific/Galapagos Pacific/Gambier Pacific/Guadalcanal Pacific/Guam Pacific/Honolulu Pacific/Johnston Pacific/Kanton Pacific/Kiritimati Pacific/Kosrae Pacific/Kwajalein Pacific/Majuro Pacific/Marquesas Pacific/Midway Pacific/Nauru Pacific/Niue Pacific/Norfolk Pacific/Noumea Pacific/Pago_Pago Pacific/Palau Pacific/Pitcairn Pacific/Pohnpei Pacific/Ponape Pacific/Port_Moresby Pacific/Rarotonga Pacific/Saipan Pacific/Samoa Pacific/Tahiti Pacific/Tarawa Pacific/Tongatapu Pacific/Truk Pacific/Wake Pacific/Wallis Pacific/Yap Poland Portugal PRC ROC Singapore US/Alaska US/Aleutian US/Arizona US/Central US/East-Indiana US/Eastern US/Hawaii US/Indiana-Starke US/Michigan US/Mountain US/Pacific US/Samoa

key: timezone


enum: diagnostic style performance experimental opinionated security

key: gocritic-tags


enum: asmdecl assign atomic atomicalign bools buildtag cgocall composites copylocks deepequalerrors errorsas fieldalignment findcall framepointer httpresponse ifaceassert loopclosure lostcancel nilfunc nilness printf reflectvaluecompare shadow shift sigchanyzer sortslice stdmethods stringintconv structtag testinggoroutine tests unmarshal unreachable unsafeptr unusedresult unusedwrite

key: govet-analyzers


$comment: This is here only to allow `additionalProperties: false`.

key: issue-match-text


key: issue-match-source


key: issue-match-path


$comment: anyOf with enum is used to allow auto completion of non-custom linters

enum: asasalint asciicheck bidichk bodyclose containedctx contextcheck cyclop deadcode decorder depguard dogsled dupl dupword durationcheck errcheck errchkjson errname errorlint execinquery exhaustive exhaustivestruct exhaustruct exportloopref forbidigo forcetypeassert funlen gci ginkgolinter gocheckcompilerdirectives gochecknoglobals gochecknoinits gocognit goconst gocritic gocyclo godot godox goerr113 gofmt gofumpt goheader goimports golint gomnd gomoddirectives gomodguard goprintffuncname gosec gosimple gosmopolitan govet grouper ifshort importas ineffassign interfacebloat interfacer ireturn lll loggercheck maintidx makezero maligned mirror misspell musttag nakedret nestif nilerr nilnil nlreturn noctx nolintlint nonamedreturns nosnakecase nosprintfhostport paralleltest prealloc predeclared promlinter reassign revive rowserrcheck scopelint sqlclosecheck staticcheck structcheck stylecheck tagalign tagliatelle tenv testableexamples testpackage thelper tparallel typecheck unconvert unparam unused usestdlibvars varcheck varnamelen wastedassign whitespace wrapcheck wsl zerologlint

description: Linters usable.

key: linters


enum: appendAssign appendCombine argOrder assignOp badCall badCond badLock badRegexp badSorting boolExprSimplify builtinShadow builtinShadowDecl captLocal caseOrder codegenComment commentedOutCode commentedOutImport commentFormatting defaultCaseOrder deferUnlambda deferInLoop deprecatedComment docStub dupArg dupBranchBody dupCase dupImport dupSubExpr dynamicFmtString elseif emptyDecl emptyFallthrough emptyStringTest equalFold evalOrder exitAfterDefer exposedSyncMutex externalErrorReassign filepathJoin flagDeref flagName hexLiteral httpNoBody hugeParam ifElseChain importShadow indexAlloc initClause ioutilDeprecated mapKey methodExprCall nestingReduce newDeref nilValReturn octalLiteral offBy1 paramTypeCombine preferDecodeRune preferFilepathJoin preferFprint preferStringWriter preferWriteByte ptrToRefParam rangeExprCopy rangeValCopy redundantSprint regexpMust regexpPattern regexpSimplify returnAfterHttpError ruleguard singleCaseSwitch sliceClear sloppyLen sloppyReassign sloppyTypeAssert sortSlice sprintfQuotedString sqlQuery stringConcatSimplify stringsCompare stringXbytes suspiciousSorting switchTrue syncMapLoadAndDelete timeCmpSimplify timeExprSimplify tooManyResultsChecker truncateCmp typeAssertChain typeDefFirst typeSwitchVar typeUnparen uncheckedInlineErr underef unlabelStmt unlambda unnamedResult unnecessaryBlock unnecessaryDefer unslice valSwap weakCond whyNoLint wrapperFunc yodaStyleExpr

key: gocritic-checks


description: add field validation by specifying a list with a regex pattern and an error message; more extensive validation can be achieved with custom widgets

description: Defaults to True

description: optionally add helper text directly below a widget.

key: widget


description: A regular expression for the path(s) to exclude.

title: Pattern

title: Exclude

key: excludeFileFilter


enum: csharp cpp go groovy java javascript objectivec perl php python ruby scala script solidity swift typescript kotlin

key: supportedProgrammingLanguage


description: Some plugins will need to be configured by adding a dynamic configuration.

key: pluginMiddleware


description:
The WRR is able to load balance the requests between multiple services based on weights.

This strategy is only available to load balance between services and not between servers.

description: When sticky sessions are enabled, a cookie is set on the initial request and response to let the client know which server handles the first response. On subsequent requests, to keep the session alive with the same server, the client should resend the same cookie.

description: Can be none, lax, strict or empty.

description: The default cookie name is an abbreviation of a sha1 (ex: _1d52e).

key: httpWeightedService


required: name weight

key: udpWeightedService


description: The AddPrefix middleware updates the URL Path of the request before forwarding it.

description: prefix is the string to add before the current path in the requested URL. It should include the leading slash (/).

key: addPrefixMiddleware


description: The ReplaceRegex replace a path from an url to another with regex matching and replacement. It will replace the actual path by the specified one and store the original path in a X-Replaced-Path header.

description: The regex option is the regular expression to match and capture the path from the request URL.

description: The replacement option defines how to modify the path to have the new target path. Care should be taken when defining replacement expand variables: $1x is equivalent to ${1x}, not ${1}x (see Regexp.Expand), so use ${1} syntax.

key: replacePathRegexMiddleware


description: PassTLSClientCert adds in header the selected data from the passed client tls certificate.

description: The info option select the specific client certificate details you want to add to the X-Forwarded-Tls-Client-Cert-Info header. The value of the header will be an escaped concatenation of all the selected certificate details.

description: The issuer select the specific client certificate issuer details you want to add to the X-Forwarded-Tls-Client-Cert-Info header.

description: Set the province option to true to add the province information into the issuer.

description: Set the locality option to true to add the locality information into the issuer.

description: Set the country option to true to add the country information into the issuer.

description: Set the serialNumber option to true to add the serialNumber information into the issuer.

description: Set the commonName option to true to add the commonName information into the issuer.

description: Set the domainComponent option to true to add the domainComponent information into the issuer.

description: Set the organization option to true to add the organization information into the issuer.

description: Set the notBefore option to true to add the Not Before information from the Validity part.

description: The subject select the specific client certificate subject details you want to add to the X-Forwarded-Tls-Client-Cert-Info header.

description: Set the province option to true to add the province information into the subject.

description: Set the locality option to true to add the locality information into the subject.

description: Set the country option to true to add the country information into the subject.

description: Set the serialNumber option to true to add the serialNumber information into the subject.

description: Set the commonName option to true to add the commonName information into the subject.

description: Set the domainComponent option to true to add the domainComponent information into the subject.

description: Set the organization option to true to add the organization information into the subject.

description: Set the sans option to true to add the Subject Alternative Name information from the Subject Alternative Name part.

description: Set the notAfter option to true to add the Not After information from the Validity part.

description: The pem option sets the X-Forwarded-Tls-Client-Cert header with the escape certificate.

key: passTLSClientCertMiddleware


description: The Headers middleware can manage the requests/responses headers.

description:
The accessControlAllowOriginList indicates whether a resource can be shared by returning different values.

A wildcard origin * can also be configured, and will match all requests. If this value is set by a backend server, it will be overwritten by Traefik

This value can contain a list of allowed origins.

description: The sslProxyHeaders option is set of header keys with associated values that would indicate a valid https request. Useful when using other proxies with header like: "X-Forwarded-Proto": "https".

description: The referrerPolicy allows sites to control when browsers will pass the Referer header to other sites.

description: Set contentTypeNosniff to true to add the X-Content-Type-Options header with the value nosniff.

description: The sslHost option is the host name that is used to redirect http requests to https.

description: Set browserXssFilter to true to add the X-XSS-Protection header with the value 1; mode=block.

description: The contentSecurityPolicy option allows the Content-Security-Policy header value to be set with a custom value.

description: Set sslForceHost to true and set SSLHost to forced requests to use SSLHost even the ones that are already using SSL.

description: Set forceSTSHeader to true, to add the STS header even when the connection is HTTP.

description: Set frameDeny to true to add the X-Frame-Options header with the value of DENY.

description: The customFrameOptionsValue allows the X-Frame-Options header value to be set with a custom value. This overrides the FrameDeny option.

description: The accessControlAllowHeaders indicates which header field names can be used as part of the request.

description: The customBrowserXssValue option allows the X-XSS-Protection header value to be set with a custom value. This overrides the BrowserXssFilter option.

description: The accessControlMaxAge indicates how long (in seconds) a preflight request can be cached.

description: The accessControlExposeHeaders indicates which headers are safe to expose to the api of a CORS API specification.

description: The featurePolicy allows sites to control browser features.

description: The stsIncludeSubdomains is set to true, the includeSubDomains directive will be appended to the Strict-Transport-Security header.

description: The accessControlAllowMethods indicates which methods can be used during requests.

description: The customRequestHeaders option lists the Header names and values to apply to the request.

description: Set stsPreload to true to have the preload flag appended to the Strict-Transport-Security header.

description: The addVaryHeader is used in conjunction with accessControlAllowOriginList to determine whether the vary header should be added or modified to demonstrate that server responses can differ based on the value of the origin header.

description: Set the sslTemporaryRedirect to true to force an SSL redirection using a 302 (instead of a 301).

description: The stsSeconds is the max-age of the Strict-Transport-Security header. If set to 0, would NOT include the header.

description: The permissionsPolicy allows sites to control browser features.

description: The sslRedirect is set to true, then only allow https requests.

description: The hostsProxyHeaders option is a set of header keys that may hold a proxied hostname value for the request.

description: The accessControlAllowCredentials indicates whether the request can include user credentials.

description: The customResponseHeaders option lists the Header names and values to apply to the response.

description: The publicKey implements HPKP to prevent MITM attacks with forged certificates.

description: The allowedHosts option lists fully qualified domain names that are allowed.

description:
Set isDevelopment to true when developing. The AllowedHosts, SSL, and STS options can cause some unwanted effects. Usually testing happens on http, not https, and on localhost, not your production domain.
If you would like your development environment to mimic production with complete Host blocking, SSL redirects, and STS headers, leave this as false.

description: The accessControlAllowOriginListRegex option is the counterpart of the accessControlAllowOriginList option with regular expressions instead of origin values.

key: headersMiddleware


description: The Compress middleware enables the gzip compression.

description:
excludedContentTypes specifies a list of content types to compare the Content-Type header of the incoming requests to before compressing.

The requests with content types defined in excludedContentTypes are not compressed.

Content types are compared in a case-insensitive, whitespace-ignored manner.

description: specifies the minimum amount of bytes a response body must have to be compressed.

key: compressMiddleware


description: The BasicAuth middleware is a quick way to restrict access to your services to known users. If both users and usersFile are provided, the two are merged. The contents of usersFile have precedence over the values in users.

description: Set the removeHeader option to true to remove the authorization header before forwarding the request to your service. (Default value is false.)

description:
The usersFile option is the path to an external file that contains the authorized users for the middleware.

The file content is a list of `name:hashed-password`.

default: traefik

description: You can customize the realm for the authentication with the realm option. The default value is traefik.

description: The users option is an array of authorized users. Each user will be declared using the `name:hashed-password` format.

description: You can define a header field to store the authenticated user using the headerField option.

key: basicAuthMiddleware


required: rule service

description: A router is in charge of connecting incoming requests to the services that can handle them. In the process, routers may use pieces of middleware to update the request, or act before forwarding the request to the service.

description: When a TLS section is specified, it instructs Traefik that the current router is dedicated to HTTPS requests only (and that the router should ignore HTTP (non TLS) requests). Traefik will terminate the SSL connections (meaning that it will send decrypted data to the services). If you need to define the same route for both HTTP and HTTPS requests, you will need to define two different routers: one with the tls section, one without.

description: Main defines the main domain name.

description: SANs defines the subject alternative domain names.

description: You can set SANs (alternative domains) for each main domain. Every domain must have A/AAAA records pointing to Traefik. Each domain & SAN will lead to a certificate request.

description: If certResolver is defined, Traefik will try to generate certificates based on routers Host & HostSNI rules.

description: The options field enables fine-grained control of the TLS parameters. It refers to a TLS Options and will be applied only if a Host rule is defined.

description: If not specified, HTTP routers will accept requests from all defined entry points. If you want to limit the router scope to a set of entry points, set the entryPoints option.

description: Each request must eventually be handled by a service, which is why each router definition should include a service target, which is basically where the request will be passed along to. HTTP routers can only target HTTP services (not TCP services).

description: Rules are a set of matchers configured with values, that determine if a particular request matches specific criteria. If the rule is verified, the router becomes active, calls middlewares, and then forwards the request to the service.

description: To avoid path overlap, routes are sorted, by default, in descending order using rules length. The priority is directly equal to the length of the rule, and so the longest length has the highest priority. A value of 0 for the priority is ignored: priority = 0 means that the default rules length sorting is used.

description: You can attach a list of middlewares to each HTTP router. The middlewares will take effect only if the rule matches, and before forwarding the request to the service. Middlewares are applied in the same order as their declaration in router.

key: httpRouter


description: Remove the matching prefixes from the URL path. It will strip the matching path prefix and will store the matching path prefix in a X-Forwarded-Prefix header.

description: The regex option is the regular expression to match the path prefix from the request URL.

key: stripPrefixRegexMiddleware


key: tcpWeightedService


description: If both HTTP routers and TCP routers listen to the same entry points, the TCP routers will apply before the HTTP routers. If no matching route is found for the TCP routers, then the HTTP routers will take over.

description:
When a TLS section is specified, it instructs Traefik that the current router is dedicated to TLS requests only (and that the router should ignore non-TLS requests).

By default, a router with a TLS section will terminate the TLS connections, meaning that it will send decrypted data to the services.

description: Main defines the main domain name.

description: A TLS router will terminate the TLS connection by default. However, the passthrough option can be specified to set whether the requests should be forwarded "as is", keeping all data encrypted.

description: If not specified, TCP routers will accept requests from all defined entry points. If you want to limit the router scope to a set of entry points, set the entry points option.

description: You must attach a TCP service per TCP router. Services are the target for the router. TCP routers can only target TCP services (not HTTP services).

description: It is important to note that the Server Name Indication is an extension of the TLS protocol. Hence, only TLS routers will be able to specify a domain name with that rule. However, non-TLS routers will have to explicitly use that rule with * (every domain) to state that every non-TLS request will be handled by the router.

key: tcpRouter


description: The mirroring is able to mirror requests sent to a service to other services. Please note that by default the whole request is buffered in memory while it is being mirrored. See the maxBodySize option for how to modify this behaviour.

description: maxBodySize is the maximum size allowed for the body of the request. If the body is larger, the request is not mirrored. Default value is -1, which means unlimited size.

key: httpMirroringService


description:
The Content-Type middleware - or rather its unique autoDetect option - specifies whether to let the Content-Type header, if it has not been set by the backend, be automatically set to a value derived from the contents of the response.

As a proxy, the default behavior should be to leave the header alone, regardless of what the backend did with it. However, the historic default was to always auto-detect and set the header if it was nil, and it is going to be kept that way in order to support users currently relying on it. This middleware exists to enable the correct behavior until at least the default one can be changed in a future version.

description: autoDetect specifies whether to let the Content-Type header, if it has not been set by the backend, be automatically set to a value derived from the contents of the response.

key: contentTypeMiddleware


key: httpFailoverService


description: The DigestAuth middleware is a quick way to restrict access to your services to known users. If both users and usersFile are provided, the two are merged. The contents of usersFile have precedence over the values in users.

description: Set the removeHeader option to true to remove the authorization header before forwarding the request to your service. (Default value is false.)

description:
The usersFile option is the path to an external file that contains the authorized users for the middleware.

The file content is a list of `name:realm:encoded-password`.

description: You can customize the realm for the authentication with the realm option. The default value is traefik.

description: The users option is an array of authorized users. Each user will be declared using the `name:realm:encoded-password` format.

description: You can customize the header field for the authenticated user using the headerField option.

key: digestAuthMiddleware


description: The ForwardAuth middleware delegate the authentication to an external service. If the service response code is 2XX, access is granted and the original request is performed. Otherwise, the response from the authentication server is returned.

description: The tls option is the TLS configuration from Traefik to the authentication server.

description: Private certificate used for the secure connection to the authentication server.

description: If insecureSkipVerify is true, TLS for the connection to authentication server accepts any certificate presented by the server and any host name in that certificate.

description: Certificate Authority used for the secured connection to the authentication server.

description: Public certificate used for the secured connection to the authentication server.

description: Policy used for the secured connection with TLS Client Authentication to the authentication server. Requires tls.ca to be defined.

description: The authResponseHeadersRegex option is the regex to match headers to copy from the authentication server response and set on forwarded request, after stripping all headers that match the regex.

description: The authRequestHeaders option is the list of the headers to copy from the request to the authentication server.

description: The authResponseHeaders option is the list of the headers to copy from the authentication server to the request.

description: The address option defines the authentication server address.

description: Set the trustForwardHeader option to true to trust all the existing X-Forwarded-* headers.

key: forwardAuthMiddleware


description: The Chain middleware enables you to define reusable combinations of other pieces of middleware. It makes reusing the same groups easier.

key: chainMiddleware


description:
The load balancers are able to load balance the requests between multiple instances of your programs.

Each service has a load-balancer, even if there is only one server to forward traffic to.

description: Configure health check to remove unhealthy servers from the load balancing rotation. Traefik will consider your servers healthy as long as they return status codes between 2XX and 3XX to the health check requests (carried out every interval). Traefik keeps monitoring the health of unhealthy servers. If a server has recovered (returning 2xx -> 3xx responses again), it will be added back to the load balancer rotation pool.

description: If defined, will apply Host header hostname to the health check request.

description: Defines the frequency of the health check calls. Interval is to be given in a format understood by `time.ParseDuration`. The interval must be greater than the timeout. If configuration doesn't reflect this, the interval will be set to timeout + 1 second.

description: If defined, will replace the server URL port for the health check endpoint.

description: Defines custom headers to be sent to the health check endpoint.

description: Defines whether redirects should be followed during the health check calls (default: true).

description: Defines the maximum duration Traefik will wait for a health check request before considering the server failed (unhealthy). Timeout is to be given in a format understood by `time.ParseDuration`.

description: path is appended to the server URL to set the health check endpoint.

description: If defined, will replace the server URL scheme for the health check endpoint

description: If defined, will apply this Method for the health check request.

description: When sticky sessions are enabled, a cookie is set on the initial request and response to let the client know which server handles the first response. On subsequent requests, to keep the session alive with the same server, the client should resend the same cookie.

description: Can be none, lax, strict or empty.

description: The default cookie name is an abbreviation of a sha1 (ex: _1d52e).

description: Defines how Traefik forwards the response from the backend server to the client.

description: Specifies the interval in between flushes to the client while copying the response body. It is a duration in milliseconds, defaulting to 100. A negative value means to flush immediately after each write to the client. The flushInterval is ignored when ReverseProxy recognizes a response as a streaming response; for such responses, writes are flushed to the client immediately.

description: The passHostHeader allows to forward client Host header to server. By default, passHostHeader is true.

description: The url option point to a specific instance. Paths in the servers' url have no effect. If you want the requests to be sent to a specific path on your servers, configure your routers to use a corresponding middleware (e.g. the AddPrefix or ReplacePath) middlewares.

description: Servers declare a single instance of your program.

key: httpLoadBalancerService


description:
As a proxy between a client and a server, it can happen that either side (e.g. client side) decides to terminate its writing capability on the connection (i.e. issuance of a FIN packet). The proxy needs to propagate that intent to the other side, and so when that happens, it also does the same on its connection with the other side (e.g. backend side).

However, if for some reason (bad implementation, or malicious intent) the other side does not eventually do the same as well, the connection would stay half-open, which would lock resources for however long.

To that end, as soon as the proxy enters this termination sequence, it sets a deadline on fully terminating the connections on both sides.

The termination delay controls that deadline. It is a duration in milliseconds, defaulting to 100. A negative value means an infinite deadline (i.e. the connection is never fully terminated by the proxy itself).

description: The address option (IP:Port) point to a specific instance.

key: tcpLoadBalancerService


description: The Retry middleware is in charge of reissuing a request a given number of times to a backend server if that server does not reply. To be clear, as soon as the server answers, the middleware stops retrying, regardless of the response status.

description: The initialInterval option defines the first wait time in the exponential backoff series.

description: The attempts option defines how many times the request should be retried.

key: retryMiddleware


description: Replace the path of the request url. It will replace the actual path by the specified one and will store the original path in a X-Replaced-Path header.

description: The path option defines the path to use as replacement in the request url.

key: replacePathMiddleware


description: If not specified, UDP routers will accept packets from all defined (UDP) entry points. If one wants to limit the router scope to a set of entry points, one should set the entry points option.

description: There must be one (and only one) UDP service referenced per UDP router. Services are the target for the router.

key: udpRouter


description: RegexRedirect redirect a request from an url to another with regex matching and replacement.

description: The regex option is the regular expression to match and capture elements from the request URL.

description: Set the permanent option to true to apply a permanent redirection.

description: The replacement option defines how to modify the URL to have the new target URL. Care should be taken when defining replacement expand variables: $1x is equivalent to ${1x}, not ${1}x (see Regexp.Expand), so use ${1} syntax.

key: redirectRegexMiddleware


description: Remove the specified prefixes from the URL path. It will strip the matching path prefix and will store the matching path prefix in a X-Forwarded-Prefix header.

description: The prefixes option defines the prefixes to strip from the request URL

description:
The forceSlash option makes sure that the resulting stripped path is not the empty string, by replacing it with / when necessary.

This option was added to keep the initial (non-intuitive) behavior of this middleware, in order to avoid introducing a breaking change.

It's recommended to explicitly set forceSlash to false.

key: stripPrefixMiddleware


description: RedirectScheme redirect request from a scheme to another.

description: The scheme option defines the scheme of the new url.

description: The port option defines the port of the new url. Port in this configuration is a string, not a numeric value.

key: redirectSchemeMiddleware


description: The ErrorPage middleware returns a custom page in lieu of the default, according to configured ranges of HTTP Status codes. The error page itself is not hosted by Traefik.

description:
The status that will trigger the error page.

The status code ranges are inclusive (500-599 will trigger with every code between 500 and 599, 500 and 599 included). You can define either a status code like 500 or ranges with a syntax like 500-599.

description: The URL for the error page (hosted by service). You can use {status} in the query, that will be replaced by the received status code.

description: The service that will serve the new requested error page.

key: errorsMiddleware


description:
The Buffering middleware gives you control on how you want to read the requests before sending them to services.

With Buffering, Traefik reads the entire request into memory (possibly buffering large requests into disk), and rejects requests that are over a specified limit.

This can help services deal with large data (multipart/form-data for example), and can minimize time spent sending data to a service.

description: You can configure a threshold (in Bytes) from which the request will be buffered on disk instead of in memory with the memRequestBodyBytes option.

description:
With the maxRequestBodyBytes option, you can configure the maximum allowed body size for the request (in Bytes).

If the request exceeds the allowed size, it is not forwarded to the service and the client gets a 413 (Request Entity Too Large) response.

description: You can configure a threshold (in Bytes) from which the response will be buffered on disk instead of in memory with the memResponseBodyBytes option.

description:
With the maxResponseBodyBytes option, you can configure the maximum allowed response size from the service (in Bytes).

If the response exceeds the allowed size, it is not forwarded to the client. The client gets a 413 (Request Entity Too Large) response instead.

description: You can have the Buffering middleware replay the request with the help of the retryExpression option.

key: bufferingMiddleware


description: The ipStrategy option defines parameters that set how Traefik will determine the client IP.

description: The depth option tells Traefik to use the X-Forwarded-For header and take the IP located at the depth position (starting from the right). If depth is greater than the total number of IPs in X-Forwarded-For, then the client IP will be empty. depth is ignored if its value is lesser than or equal to 0.

description: excludedIPs tells Traefik to scan the X-Forwarded-For header and pick the first IP not in the list. If depth is specified, excludedIPs is ignored.

key: ipStrategy


description:
The circuit breaker protects your system from stacking requests to unhealthy services (resulting in cascading failures).

When your system is healthy, the circuit is closed (normal operations). When your system becomes unhealthy, the circuit becomes open and the requests are no longer forwarded (but handled by a fallback mechanism).

To assess if your system is healthy, the circuit breaker constantly monitors the services.

description: The interval between successive checks of the circuit breaker condition (when in standby state)

description: The duration for which the circuit breaker will try to recover (as soon as it is in recovering state).

description: You can specify an expression that, once matched, will trigger the circuit breaker (and apply the fallback mechanism instead of calling your services).

description: The duration for which the circuit breaker will wait before trying to recover (from a tripped state).

key: circuitBreakerMiddleware


description: The servers load balancer is in charge of balancing the requests between the servers of the same service.

description: The servers field defines all the servers that are part of this load-balancing group, i.e. each address (IP:Port) on which an instance of the service's program is deployed.

key: udpLoadBalancerService


required: rule match

description: Shell Rule

enum: darwin macos freebsd linux sunos win32 windows

description: A regexp to search the output.

key: shell


required: rule binary

description: CLI Rule

type: string integer

key: cli


required: rule variable

description: ENV Rule

key: env


required: rule plugin name

description: Custom Rule

description: A regexp to search the output.

key: custom


required: rule location

description: File Rule

key: file


description: Dir Rule

enum: dir directory

key: dir


title: Return finding where Python expression returns true

key: pattern-where-python


key: metavariable-comparison


title: Return findings only from within snippets Semgrep pattern matches

key: pattern-inside


required: analyzer metavariable

key: metavariable-analysis


title: Do not return findings from within snippets Semgrep pattern matches

key: pattern-not-inside


required: metavariable regex

key: metavariable-regex


title: Focus on what a given metavariable is matching

key: focus-metavariable


title: Return finding where regular expression matches

key: pattern-regex


title: Return finding where Semgrep pattern matches exactly

key: pattern


title: Do not return finding where regular expression matches

key: pattern-not-regex


title: Rule ID to attach to findings

key: id


required: namespace package version

title: One or more dependencies that the project contains in a lock file


title: Do not return finding where Semgrep pattern matches exactly

key: pattern-not


enum: read-only write-only read-write not-accessible

description: Access level to the datapoint. This is specific for each driver

title: Datapoint access type

errorMessage: Datapoint access type should be a string and one of: read-only, write-only, read-write, not-accessible

markdownDescription: Access level to the datapoint. [This is specific for each driver](https://docs.netin.io/netin_webUI/NetinDS/templates/templates-origintype/#drivers)

key: originAccessTypeDef


description: Fixed value designating the version of the template schema

title: Schema version

errorMessage: Not valid version string, for more information see : https://semver.org/

markdownDescription: SemVer style template schema version [See the documentation](https://semver.org/)

key: schemaVersionDef


description: Alarm/event descriptive text

title: Alarm related text

errorMessage: Should be a string of at least one character and less than 500 characters

key: textDef


enum: map tableStatic tableDynamic

description: Define the data structure of this datapointSet, check the documentation for more information

title: DatapointSet type

errorMessage: datapointSetType should be a string. DatapointSet type is datapointSetType, and should be one of: map, tableStatic, tableDynamic

markdownDescription: Define the data structure of this datapointSet, check the [documentation](https://docs.netin.io/netin_webUI/NetinDS/templates/#datapointsets) for more information

key: datapointSetTypeDef


description: Regular expression for PROFINET manufacturer identification field in hexadecimal format

title: vendorID regex

errorMessage: vendorID should be a string

markdownDescription: Regular expression for [PROFINET manufacturer](https://www.profibus.com/IM/Man_ID_Table.xml) identification field in hexadecimal format

errorMessage: DeviceID should be a string

description: Regular expression for PROFINET device identification field in hexadecimal format

title: deviceID Regex

description: Regular expression for SNMP sysDescr OID (1.3.6.1.2.1.1.1) device description

title: Device description Regex

errorMessage: description should be a string of at least one character and maximum 800 characters

description: Ranger filter for a PROFINET device

label: PROFINET based

description: SIMATIC NET

description: Ranger filter for a SNMP device

label: SNMP based

description: Tags used by Ranger to match discoverd devices with their respective templates

title: Ranger match configuration

key: rangerFilterDef


enum: map table metric gauge

description: Select widget type

title: Widget type

errorMessage: Widget type should be one of the following options: map, table, metric, gauge

examples: map table

description: Define de position of the widget, first column

title: Column position

errorMessage: First column should be a number between 1 and 8

description: Define de size of the widget, height

title: Widget height size

errorMessage: Widget height should be a number greater than 1

description: Define de position of the widget, first row

title: Row position

errorMessage: First row should be a number greater than 1

description: Define de size of the widget, width

title: Widget width size

errorMessage: Widget width should be a number between 1 and 8

description: Text for widget title

title: Widget title

errorMessage: Widget title should be a string of at least one character and maximum 800 characters

examples:
Device Info
PNIO-Fault

required: firstRow firstColumn widgetWidth widgetHeight widgetType widgetTitle

description: Common fields for grid representation

title: Common representation properties

key: representationCommonConfigDef


description: Frequency in which the driver should update the value of this datapoint. This is specific for each driver

title: Polling group

errorMessage: Polling group should be a string and one of: 5s, 10s, 30s, 1m, 5m, 10m, 15m, 30m, 1h, 4h, 6h, 12h, 1d

markdownDescription: Frequency in which the driver should update the value of this datapoint. [This is specific for each driver](https://docs.netin.io/netin_webUI/NetinDS/templates/templates-origintype/#drivers)

key: pollingGroupDef


errorMessage: Should be a string of less than 80 characters

description: Define the topic that should be used to transport the data

title: Topic identification

description: Object to define the specific configuration of the service

title: Service configuration

description: Define the service that should consume the information

title: Service identification

key: routingDef


errorMessage: DataType should be one of: BYTE, INTEGER, LONG, FLOAT, DOUBLE, STRING, BOOLEAN, DATE, ARRAY, INTEGER_ARRAY, STRING_ARRAY, DOUBLE_ARRAY, BOOLEAN_ARRAY, FLOAT_ARRAY, LONG_ARRAY, OBJECT

description: Define the type of the data in the NetinDS context, this means how NetinDS will manage the data before the conversions

title: NetinDS data type

key: dataTypeDef


errorMessage: origin should be a string. Maximum size of 80 alphanumerical characters or symbol: -_.

description: Monitored system, subsystem, device or ... source of the datapoint

title: Origin

key: originDef


description: Allows converts rawValue to value based in a key/value map

title: Map based conversion configuration

markdownDescription: Allows converts rawValue to value based in a [key/value](https://docs.netin.io/netin_webUI/NetinDS/templates/#valuemapconfig) map

description: Entry value

title: Value

description: Entry key

title: Key

description: Entry in the key/value map

title: Entry

description: Key/Value map with the conversion options

title: Map

key: valueMapConfigDef


errorMessage: DatapointSet identification must be alphanumeric string [1-40], "-" & "_" are also allowed

description: DatapointSet identification string

title: DatapointSet identification

key: datapointSetIdDef


errorMessage: Should be a string of at least one characters and less than 40 characters

description: Identification string for logic expression

title: Symbol ID

key: symbolDef


description: Datapoints that widget will use for representation

title: Widget data

errorMessage: Data should be an string of device[datapointSetId] or device[datapointSetId.datapointId]

key: representationDataDef


errorMessage: rootAddress should be a string [0-240]

description: Main address for the table, this information is specific for each kind of driver

title: Table root address

description: One of the datapointId of the table type datapointSet

title: Table index

errorMessage: Indexes must be an array of datapoint identification strings

description: Array of datapointIds that will act as table indexes, this means columns that acts as keys of the table

title: Tables indexes

description: Specific configuration for tabled based datapointSets

title: Table address config

key: tableAddressDef


enum: SIMPLE TIMEPOINT DATAPOINT @DATAPOINT @TIMEPOINT #DATAPOINT #TIMEPOINT

description: Define the kind of information types, within NetinDS context, that the driver/zavod instances will generate for this datapoint

title: Datapoint type

errorMessage: DatapointType must be one of: SIMPLE, TIMEPOINT, DATAPOINT, @DATAPOINT, @TIMEPOINT, #DATAPOINT, #TIMEPOINT

markdownDescription: Define the kind of [information types](https://docs.netin.io/netin_webUI/NetinDS/templates/templates-datapointsets/#commonconfig), within NetinDS context, that the driver/zavod instances will generate for this datapoint

key: datapointTypeDef


errorMessage: Should be a string and follow the pattern: alphanumerical and symbols #&_- with less than 41 characters

description: Datapoint identification string

title: Datapoint identification

key: datapointIdDef


description: SemVer style template version

title: Template version

errorMessage: templateVersion should be a valid version string. For more information see : https://semver.org/

markdownDescription: SemVer style template version [See the documentation](https://semver.org/)

key: templateVersionDef


errorMessage: Should be a string and follow the pattern: alphanumerical characters and - symbol, maximum length 80

description: Driver (Origin type) identification string for the driver

title: Driver (Origin type) identification

key: originTypeDef


errorMessage: Should be boolean

description: Flag to indicate that the alarm is hidden by user request

title: Hidden flag

key: hiddenDef


errorMessage: templateId should be a string. Maximum size of 80 alphanumerical characters or symbol: -_

description: Template identification string

title: Template identification

key: templateIdDef


description: Level of criticality of the log

title: Log severity

errorMessage: Should be a number greater than 0 and lower than 201

markdownDescription: [Level](https://docs.netin.io/netin_webUI/NetinDS/templates/templates-datapointsets/#rangos-de-severidad) of criticality of the alarm

key: severityForLogsDef


errorMessage: Driver side data type should follow the pattern: alphanumerical string +"-" and "_", size [1-80]

description: Define the type of the data in the driver context, this means how the type of data that driver expect to collect

title: Driver data type

key: originDataTypeDef


description: Define url to opened on click event

title: Metric url

description: Indicate if event click must be enable

title: Enable click

description: Indicate if tittle should be shown

title: Tittle show

description: Indicate if timestamp should be shown

title: Metric

description: Specific configuration for metric widget representation

title: metric widget representation

key: representationMetricConfigDef


description: Value or rawValue of a datapoint

title: Datapoint value or rawValue

key: valueDef


enum: polling singleQuery subscription

description: Define how the driver should get the value of this datapoint. This is specific for each driver

title: Receive mode

errorMessage: Receive mode should be a string and one of: polling, singleQuery, subscription

markdownDescription: Define how the driver should get the value of this datapoint. [This is specific for each driver](https://docs.netin.io/netin_webUI/NetinDS/templates/templates-origintype/#drivers)

key: receiveModeDef


description: Logic operation to be applied between all the expressions

title: Logic operation

errorMessage: Should be a string of at least one character and less than 80 characters

key: logicDef


description: Define the address of this datapoint. This is specific for each driver

title: Datapoint address (drivers side)

errorMessage: Datapoint address should be an alphanumerical string [1-80] and [_&#:$.-]

markdownDescription: Define the address of this datapoint. [This is specific for each driver](https://docs.netin.io/netin_webUI/NetinDS/templates/templates-origintype/#drivers)

key: originAddressDef


description: Detailed information about the device or system to be monitored by this device

title: Template description

errorMessage: description should be a string of at least one character and maximum 800 characters

key: descriptionDef


description: Level of criticality of the alarm

title: Alarm severity

errorMessage: Should be a number greater than -1 and lower than 1001

key: severityDef


description: Allows converts between measure units

title: Units conversion configuration

required: toBest exclude

required: from to

required: from toBest

markdownDescription: Allows converts between [measure units](https://docs.netin.io/netin_webUI/NetinDS/templates/#unitsconfig)

examples: m g

description: Exclude measure unit

title: Exclude unit

description: Array of excluded measure units, when toBest is enabled

title: Exclude

description: Desired measure units

title: To

description: Flag to indicate that the unit of measure must indicated

title: Units

description: Actual measure units

title: From

description: Select the measure unit that best fit

title: To best

key: unitsConfigDef


description: Level of criticality of the alarm

title: Alarm severity

errorMessage: Should be a number greater than 200 and lower than 1001

key: severityForAlarmsDef


description: Expression to be evaluated by NetinDS-Zavod

title: Expression

errorMessage: Should be a string of at least one character and less than 800 characters

markdownDescription: Expression to be [evaluated](https://docs.netin.io/netin_webUI/NetinDS/templates/templates-datapointsets/) by NetinDS-Zavod

key: expressionDef


errorMessage: Broadcast flag should be a boolean

description: Flag to indicate that the alarm/datapointSet will be broadcasted to NetinHUB channels

title: Broadcast flag

key: broadcastDef


description: Ident number for the resource group

title: Resource group ID

errorMessage: Should be a number in the range [-1, 255]

markdownDescription: [Ident number](https://docs.netin.io/netin_webUI/NetinDS/templates/templates-datapointsets/#grupos-de-recursos) for the resource group

key: facilityDef


description: Flag indication for audit process

title: Alarm in audit process

key: auditedDef


description: environment variable

description:
Environment values for the current build task
https://no0dles.gitbook.io/hammerkit/build-file/environment-variables

title: environment variables

key: buildFileEnvs


description:
Task dependencies that get executed before the current task
https://no0dles.gitbook.io/hammerkit/task/dependencies

key: taskDeps


description:
Extension task as a base template
https://no0dles.gitbook.io/hammerkit/task/extending

key: taskExtend


description:
Service needs that need to get ready before the current task
https://no0dles.gitbook.io/hammerkit/task/needs

key: taskNeeds


description:
The task runs continuous and does not end without cancellation
https://no0dles.gitbook.io/hammerkit/task/watching#continuous-tasks

key: taskContinuous


description: Description for the current task

key: taskDescription


description: label value

description:
A map of label values for the current task
https://no0dles.gitbook.io/hammerkit/labels

title: label options

key: taskLabels


description:
Kubernetes service for the current build file
https://no0dles.gitbook.io/hammerkit/service/kubernetes

title: kubernetes service

required: context selector ports

description:
Selector to specify which resource gets forwarded to
https://no0dles.gitbook.io/hammerkit/service/kubernetes

title: service selector

required: type name

enum: deployment service pod

description: resource type for the current service

description: resource name for the kubernetes resource

description: <localPort>:<targetPort>

description: A list of ports that get exposed on the host from the service <localPort>:<targetPort>

description:
Kubernetes context for the current service
https://no0dles.gitbook.io/hammerkit/service/kubernetes#config

description:
Kube config for the current service
https://no0dles.gitbook.io/hammerkit/service/kubernetes#config

key: kubernetesService


description: environment value

description:
Environment values for the current build file
https://no0dles.gitbook.io/hammerkit/build-file/environment-variables

title: task environment variables

key: taskEnvs


enum: checksum modify-date none

description:
compare type for detecting changes in source files
https://no0dles.gitbook.io/hammerkit/task/caching

key: taskCache


description:
Container service for the current build file
https://no0dles.gitbook.io/hammerkit/service/kubernetes

title: container service

description: environment value

description:
Environment values for the current service
https://no0dles.gitbook.io/hammerkit/build-file/environment-variables

title: service environment variables

description:
Check to detect if the service is started and ready
https://no0dles.gitbook.io/hammerkit/service/container#healthcheck

title: service healthcheck

description: task to check if the service is healthy

description: Container image for the current service to run commands in

description:
A map of label values for the current service
https://no0dles.gitbook.io/hammerkit/labels

title: label options

description: <name>:<containerPath>

description:
A list of volumes that get attached to the container <name>:<containerPath>
https://no0dles.gitbook.io/hammerkit/service/container#mounts

description: <localPath>:<containerPath>

description:
File paths that get mounted into the container <localPath>:<containerPath>
https://no0dles.gitbook.io/hammerkit/service/container#mounts

description: <localPort>:<targetPort>

description:
A list of ports that get exposed on the host from the container <localPort>:<targetPort>
https://no0dles.gitbook.io/hammerkit/service/container#mounts

key: containerService


description:
The collection permalink format
https://jekyllrb.com/docs/permalinks/#collections

examples: /:collection /:path /:name /:title /:output_ext

key: collection-permalink


$id: nullable-boolean

description: Copy of definition from https://json.schemastore.org/base.json#/definitions/nullable-boolean

key: nullable-boolean


default: date

description:
The global permalink format
https://jekyllrb.com/docs/permalinks/#global

key: global-permalink


description: If your content involves code snippets, this is the fieldtype for you.

description: Show Line Numbers

description: Enable Line Wrapping

default: default

enum: default sublime vim

description: Choose preferred set of keyboard shortcuts.

enum: light material

description: Choose your preferred theme.

enum: clike css diff go haml handlebars htmlmixed less markdown gfm nginx text/x-java javascript jsx text/x-objectivec php python ruby scss shell sql twig vue xml yaml-frontmatter

description: Choose language for syntax highlighting.

enum: tabs spaces

description: Set your preferred type of indentation.

const: code

description: Set your preferred indentation size (in spaces).

key: code


description: The button group fieldtype is a multiple choice input where you only get one choice.

description: Set the default value.

type: object array

description: Set the array keys and their optional labels.


description: This fieldtype is a highly configurable color picker with simple and advanced UI modes, support for alpha channel, rgba, hsla, hsva, and more.

default: hex

description: Choose which color modes you want to enable in the UI. Available choices: hex, rgba, hsla, hsva, and cmyk. Default: hex.

enum: hex rgba hsla hsva cmyk

description: Pre-define colors that can be selected from a list. Supports all color mode formats.

default: HEXA

enum: HEXA RGBA HSLA HSVA CMYK

description: Set which color mode you wish to be the default. Default: hex.

enum: classic nano

description: Choose between a classic and a simpler nano (mini) theme. Default: classic.

description: Disables the alpha slider, preventing adjustments to opacity.

const: color

key: color


description: A nice little toggle switch generally used to manage settings-type variables.

const: toggle

key: toggle


description: The radio fieldtype is a multiple choice input where you only get one choice.

description: Show the radio buttons next to each other in a row instead of stacked vertically. Default: false

const: radio

description: Sets of key/value pairs define the values and labels of the radio options.

key: radio


description: This fieldtype gives you a way to create flexible tabular data.

const: table

key: table


description: The Replicator is a meta fieldtype giving you the ability to define sets of fields that you can dynamically piece together in whatever order and arrangement you imagine.

const: replicator

key: replicator


pattern: hidden

description: Controls whether the field should be shown in control panel listings.

key: listable


description: This field is a code fieldtype that gets saved as YAML instead of a string.

const: yaml

key: yaml


description: If you've ever wanted to add a little HTML to your blueprint, this is the way to do it.

description: Store whatever HTML you want — it's up to you.

const: html

key: html


description: This is generally used as a "system" field to control an entry's template.

const: template

key: template


description: Importing Fieldsets. They serve to create reusable sets of fields, just like v2.

key: import


description: The hidden field is perfect for setting default data when creating new entries.

const: hidden

key: hidden


enum: above below

description: Where the instructions should be positioned relative to the field. Options: Above or Below.


description: Enable Antlers parsing in this field's content.

key: antlers


description: The revealer is a simple button that reveals conditional fields without saving any additional data.

const: revealer

key: revealer


enum: accepted active_url required alpha alpha_dash alpha_num array bail boolean confirmed current_password date declined dimensions distinct email enum exclude file filled image integer ip ipv4 ipv6 json nullable numeric password present prohibited string timezone url uuid

key: validationRules


description: The grid fieldtype is a meta fieldtype, a fieldtype that serves as a container for more fieldtypes.

description: The minimum number of required rows.

description: A list of fields, each of which create their own column.

description: The minimum number of required rows.

description: The maximum number of rows allowed. Once reached the Add Row button will disappear.

enum: table stacked

description: The Grid is displayed as a table by default. If you have a large number of columns it can get pretty crowded. Choose stacked mode to group rows similar to Replicator. When Sneak Peek is enabled, Grids automatically toggle into stacked mode.

description: The Add Row button's label.

const: grid

key: grid


description: Work with dates, times, and ranges with a variety of user interface options that make you really enjoy basically just picking numbers from a table.

description: Show multiple months at one time, in columns and rows. Default: 1.

description: Enable to stretch the calendar out like Stretch Armstrong, using the maximum amount of available horizontal space. Default: false

description: How the date should be stored, using the PHP date format. Default: 'Y-m-d' or 'Y-m-d H:m'

description: Makes the time field visible and non-dismissible. Default: false.

default: single

enum: single range

description: Choose between single or range. Range mode disables the time picker. Default: single.

description: Enable/disable the timepicker. Default: false.

description: Always show the calendar instead of the text input and dropdown UI. Default: false.

format: date

format: date-time

description: Set the earliest selectable date in YYYY-MM-DD format.

const: date

key: date


description: The integer fieldtype is a text-style input that only accepts integers (numbers) and has increment and decrement controls.

const: integer

key: integer


description: The icon

key: icon


description: The assets fieldtype is used to manage and relate files with your entries.

default: list

enum: grid list

const: assets

key: assets


description: Shown under the field's display label, like this very text. Markdown is supported.

key: instructions


description: Control whether or not this field is required.

key: required


description: For when you want to manage a simple YAML list, this fieldtype is here for you.

const: list

key: list


enum: default select typeahead

key: userSelectModes


description: Range fields let the user choose a numeric value which must be no less than a given value, and no more than another.

description: Set the default value.

description: The maximum, right-most value.

description: The minimum size between values.

const: range

description: The minimum, left-most value.

key: range


description: The checkboxes fieldtype is a multiple choice input.

default: false

const: checkboxes

key: checkboxes


description: The original time field from the set of Kiefer Sutherland's hit drama "24".

const: time

key: time


description: For when you want to create a link to a URL or entry, this fieldtype is here for you.

const: link

key: link


description: The label shown above the field.

key: display


required: id generation

$comment: Should become it's own schema file'

description: The configuration of an artifact

description: The artifact generation

description: The artifact id

key: artifact


description: Default value of the field.

description: The type of the field.

title: Fields

key: Fields


description: File format version

key: fileVersion


type: boolean string

description: Share pseudonymous usage data with the Angular Team at Google.

enum: npm cnpm yarn pnpm

description: Specify which package manager tool to use.

description: Control disk cache.

enum: local ci all

description: Configure in which environment disk cache is enabled.

description: Cache base path.

description: Configure whether disk caching is enabled.

description: The list of schematic collections to use.

description: Control CLI specific console warnings

description: Show a warning when the global version is newer than the local one.

key: cliOptions


description: Angular CLI completion settings.

description: Whether the user has been prompted to add completion command prompt.

description: Share pseudonymous usage data with the Angular Team at Google.

description: Specify which package manager tool to use.

description: The list of schematic collections to use.

description: Control CLI specific console warnings

description: Show a warning when the global version is newer than the local one.

key: cliGlobalOptions


body: {backend.response.headers.<HeaderName>}

description: Read from one of the backend response headers

label: Backend Response Header

body: {backend.response.statusCode}

description: Read the backend response status code.

label: Backend Response Status Code

body: {backend.response.statusReason}

description: Read the backend response status reason.

label: Backend Response Status Reason

body: {request.headers.<HeaderName>}

description: Read from one of the original request headers

label: Original Request Header

body: {request.querystring.<ParameterName>}

description: Read one of the original request query string parameters

label: Original Request Query String

body: {request.method}

description: Read the original request method

label: Original Request Method

body: {backend.request.headers.<HeaderName>}

description: Read from backend request headers

label: Backend Request Header

body: {backend.request.querystring.<ParameterName>}

description: Read one of the backend request query string parameters

label: Backend Request Query String

body: {backend.request.method}

description: Read the backend request method

label: Backend Request Method


enum: GET POST HEAD OPTIONS PUT TRACE DELETE PATCH CONNECT

key: http-method-schema


body: {request.headers.<HeaderName>}

description: Read from one of the request headers

body: {request.querystring.<ParameterName>}

label: Original Request Query String Parameter

body: {request.method}

description: Read the request method


required:
// autoCompress (1)
// autoCompress (2)
// autoCompress (3)
autoCompress
// ignoreReadErrors
ignoreReadErrors
// throttleFS (1)
// throttleFS (2)
throttleFS

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

required:
// intervalMs
intervalMs
// maxBufferedCommands
maxBufferedCommands

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

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

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: sizeFactor sizeFactorMinimumSize

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.

key: JsonlOptions


required:
disabled
files
// files
hours
// hours
period
// period
path
// path

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

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

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

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

key: DatabaseBackupOptions


description: CFML engine the package supports

description: The semantic version of the engine that is supported

title: Engine Version

enum: railo lucee adobe

description: The name of the engine

title: Engine Type

key: engine


description: Dependencies are specified with a package name/slug to version range, local file path, URL, or Git/SVN endpoint. The version range is a string which has one or more space-separated descriptors.

title: Dependency

key: dependency


description: A person who has been involved in creating or maintaining this package

description: URL for the person

description: Name of the person

description: Email address of the person

key: person


enum: allow deny

key: insecure-external-code-execution


enum: daily weekly monthly

key: schedule-interval


description: Always increase the version requirement to match the new version.

description: Follow the default strategy described above.

description: Increase the version requirement only when required by the new version.

description: Relax the version requirement to include both the new and old version, when possible.

description: Only create pull requests to update lockfiles updates. Ignore any new versions that would require package manifest changes.

enum: lockfile-only auto widen increase increase-if-necessary

key: versioning-strategy


enum: monday tuesday wednesday thursday friday saturday sunday

key: schedule-day


description: The username that Dependabot uses to access the registry.

description: For registries with type: python-index, if the boolean value is true, pip resolves dependencies by using the specified URL rather than the base URL of the Python Package Index (by default https://pypi.org/simple).

description: The URL to use to access the dependencies in this registry. The protocol is optional. If not specified, https:// is assumed. Dependabot adds or ignores trailing slashes as required.

description: A reference to a Dependabot secret containing an access token for this registry.

description: A reference to a Dependabot secret containing an access key for this registry.

description: A reference to a Dependabot secret containing the password for the specified user.

enum: composer-repository docker-registry git hex-organization hex-repository maven-repository npm-registry nuget-feed python-index rubygems-server terraform-registry

description: Identifies the type of registry.

description: The top-level registries key is optional. It allows you to specify authentication details that Dependabot can use to access private package registries.

title: registries

key: registry


enum: bundler cargo composer docker elm gitsubmodule github-actions gomod gradle maven mix npm nuget pip pub terraform

key: package-ecosystem