key: direction

description: The direction of crossing the threshold to record.


key: items

description: The concatenate step takes any number of inputs (at least 2) of the same (or equivalent) types and appends the values into one output. This will be done on each component, if they exist.

type: object

type: string array null


key: concatenate


description:
The vector step takes one or three inputs and outputs a vector sequence signal.

If given three numeric or 1-dimensional series inputs, each input will be assigned to the x, y, and z components, respectively.

Alternatively, if only one input is given and it contains at least three components, the first three components will be used to construct the vector sequence.

If the inputs have different lengths, the output signal will be the length of the longest input and shorter inputs will be padded with NaN values.


key: vector


key: where

description:
When importing a signal or defining an output node, you can specify a measurement from which the signal should be imported – or for which measurement an output node should run.

You can filter measurements by name and by field values and you can use wildcard characters `*` to formulate patterns to match partial values. The matching of values is case-insensitive.

When using a measurement filter, a list of matching measurements is created. By specifying the `index` option, you can define which of the matching measurements should apply.

type: string

type: integer string

enum: first last


key: name

description: Target a measurement by name


key: index

description: Out of a number of matching measurements, pick the nth match. Either a 1-based index, or the values `first` or `last` to select the first or last match, respectively.


key: fields

description: Target a measurement by a field value.


key: set

description:
Used to specify which _set_ the exported parameter will use. In most cases, this will be either `left` or `right`.

If not set, the JSON output will use set: null.


key: spaceOrigin

description: Sets the origin of a custom coordinate system.

type: string array


key: spacePrimaryAxis

description:
Sets the primary axis of a custom coordinate system. The primary axis of the custom coordinate system will always be a unit vector with the same direction as this vector.

If more than one vectors is given, for example [myMarker1, myMarker2], the vector difference between the first two vectors is used as the primary axis.


key: spaceSecondaryAxis

description:
Sets the secondary axis of a custom coordinate system. The actual secondary axis of the custom coordinate system might differ from the vector specified, since the secondary axis must be a unit vector perpendicular to the primary axis.

If more than one vectors is given, for example [myMarker1, myMarker2], the vector difference between the first two vectors is used as the secondary axis.


key: spaceOrder

description:
Defines what axis the primary and secondary axis corresponds to. The first letter defines the name of the primary axis, and the second letter defines the name of the secondary axis.

Possible values:
xy - Primary axis: x, secondary axis: y
yx - Primary axis: y, secondary axis: x
xz - Primary axis: x, secondary axis: z
yz - Primary axis: y, secondary axis: z
zy - Primary axis: z, secondary axis: y

enum: xy yx xz yz zy


key: spaceAlignWithSegment

description:
Used to create a space that aligns with the specified segment. The resulting space will be rotated in 90 degree increments relative to the world space.

The rotation is based on the average orientation of the segment during a measurement.


key: segment


key: Parameter Node

description: A parameter node defines steps used to calculate a value or a sequence of values. The result is exported to the global scope and exported in the resulting JSON file.

required: parameter steps


key: globalOption export

description:
If this option is set, the result of this step will be exposed on the global scope, as well as being exported to the resulting JSON file.

The value of this option will be the name of the exported data and can be used to load the resulting data in other steps.


key: globalOption output

description:
If this option is set, the result of this step will be exposed on the local scope.

The value of this option will be the name of the output data and can be used to load the resulting data in other steps within the same output node.

You can also use the short-form "arrow syntax" to define an output.


key: globalOption set

description:
Used to specify which set the exported parameter will use. In most cases, this will be either left or right.

This option is only used in two cases; where there is also an export option set, or on the last step in a list. In the latter case, the step's set is used only if there's no set defined on the parent output node.

If this option is not set, the JSON output will use set: null.


key: globalOption space

description:
This option lets you reference a space where you want the input data for the step to be translated into.

All named inputs will automatically be converted.

NOTE: This is not yet implemented for segments.


key: categoryOption Angle project

description:
If set to a string, the angle will be calculated in two dimensions on the specified coordinate plane by ignoring the component of the input signals which is not part of the plane.

Using a PlaneSequence, projects the input vectors on the provided plane.

Note: _The projection is only applied for vector-based angles and is ignored when calculating joint angles._

project

category: Angle


key: categoryOption Angle rotationOrder

description:
The rotation order to use for calculating the Euler angle. Possible rotation orders are:

Cardan sequence: XYZ YZX ZXY XZY YXZ ZYX

Euler sequence: XYX XZX YXY YZY ZXZ ZYZ


key: categoryOption Angle unwrap

description:
When set to true, an event, or a numeric value, the unwrap option shifts the angle phases in order to achieve a continuous curve, i.e., it tries to detect when an angle crosses over its available range (-PI to PI for radians, -180 to 180 degrees).

This allows for tracking angles on movements that goes outside of the typical angle range.

To do this, it looks for jumps between consecutive angles. If the jump is greater than a threshold of half the range (PI for radians, 180 for degrees), the angle is shifted by adding multiples of of the range until the jump no longer crosses the threshold.

The unwrap algorithm is run over all available components.

If set to true or 0, the algorithm aligns the unwrap to the start of the sequence. I.e., it assumes the first frame is correct in being within the original range and the following angles are moved to follow suit.

If set to an Event or a Number, the algorithm will assume that the corresponding frame is correct in being within the original range. All other angles will be shifted to follow suit. This enables tracking a rotational movement where the angle for a specific event is intended to be within the standard range (-PI to PI for radians, -180 to 180 degrees).

IF a supplied event has more than one instance, the first instance is used.

Note: _The unwrap algorithm is sensitive to noise, which may introduce unexpected artifacts. Please consider filtering the signal(s) before calculating its angle using unwrap._

unwrap

type: string boolean number


key: categoryOption Aggregation useCycles

description:
If the signal has cycles defined, the aggregation will be run separately over each signal, and a list of values are returned, one for each cycle.

To avoid this behaviour, set useCycles to false.

For information on how to set event cycles on a signal, see the eventMask step.

useCycles

type: string boolean

category: Aggregation


description:
If set to any value but none, the input signals will pass through a function which returns a list of signals where each value is from a frame greater than or equal to the frame of the corresponding value from the preceding Signal.

If set to forward, it will start from the first value of the first (leftmost) input signal (operand) and the algorithm will look at subsequent operands (to the right) one "row" at a time.

Conversely, if set to reverse, the event sequencing uses the reverse order of operands and goes from right to left.

If a full "row" of values could not be matched, it is not included in the result, i.e., all operands will be of the same length.

This is useful, for example, when calculating the distance between two signals at a certain event.

The function will only apply if all input signals have applied a Frames filter, otherwise the signals are left untouched.

Example

subtract: [LeftFoot.y@LFS, RightFoot.y@RFS]            frameSequenceOrder: reverse

_Creates an event sequence from the inputs, starting from the second operand (RFS event) and creates event pairs RFS -> LFS out of the values. It then subtracts each frame from the RightFoot from the corresponding LeftFoot frame._

_If frameSequenceOrder had been set to forward, it would have created pairs going from LFS -> RFS instead._

_Using the frameSequenceOrder option ensures that the operands starts with the intended event and that both operands have the same length._

frameSequenceOrder

category: Arithmetic


description:
Settings
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

enum: black red green yellow blue magenta cyan white bold default reverse underline strikethrough

type: integer

enum: auto en pl nl de tr

default: auto

type: array

type: boolean

type: number

enum: normal half fullscreen

default: normal

enum: long short icon

default: long

default: docker-compose

default: {{ .DockerCompose }} restart {{ .Service.Name }}

default: {{ .DockerCompose }} up -d

default: {{ .DockerCompose }} down

default: {{ .DockerCompose }} down --volumes

default: {{ .DockerCompose }} up -d {{ .Service.Name }}

default: {{ .DockerCompose }} start {{ .Service.Name }}

default: {{ .DockerCompose }} stop {{ .Service.Name }}

default: {{ .DockerCompose }} logs --since=60m --follow {{ .Service.Name }}

default: {{ .DockerCompose }} logs --follow {{ .Service.Name }}

default: {{ .DockerCompose }} up -d --build {{ .Service.Name }}

default: {{ .DockerCompose }} up -d --force-recreate {{ .Service.Name }}

default: {{ .DockerCompose }} logs --tail=300 --follow

default: {{ .DockerCompose }} logs

default: {{ .DockerCompose }} config

default: {{ .DockerCompose }} config --quiet

default: {{ .DockerCompose }} top {{ .Service.Name }}

default: open {{filename}}

default: open {{link}}

examples: docker exec -it {{ .Container.ID }} bash

examples: <dev> <prod>


key: gui

description:
UI settings
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: auto

default: normal

default: long


key: scrollHeight

description:
A scroll height
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: language

description:
A language
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: theme

description:
Theme settings
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: activeBorderColor

description:
An active border color
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: inactiveBorderColor

description:
An inactive border color
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: selectedLineBgColor

description:
A selected line background color
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: optionsTextColor

description:
An option text color
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: returnImmediately

description:
Whether to return immediately
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: wrapMainPanel

description:
Whether to wrap main panel
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: sidePanelWidth

description:
A side panel ratio of screen's width
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: showBottomLine

description:
Whether to show bottom line
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: expandFocusedSidePanel

description:
Whether to expand focused side panel
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: screenMode

description:
A screen mode
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: containerStatusHealthStyle

description:
A style of container status and it's health display
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: logs

description:
Log settings
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: timestamps

description:
Whether to show timestamps
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: since

description:
A start time
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: tail

description:
A last line count
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: commandTemplates

description:
Command templates
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: docker-compose

default: {{ .DockerCompose }} restart {{ .Service.Name }}

default: {{ .DockerCompose }} up -d

default: {{ .DockerCompose }} down

default: {{ .DockerCompose }} down --volumes

default: {{ .DockerCompose }} up -d {{ .Service.Name }}


key: dockerCompose

description:
A docker compose command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: restartService

description:
A restart service command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: up

description:
An up command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: down

description:
A down command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: downWithVolumes

description:
A down with volumes command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: upService

description:
An up service command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: startService

description:
A start service command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} start {{ .Service.Name }}


key: stopService

description:
A stop service command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} stop {{ .Service.Name }}


key: serviceLogs

description:
A service logs command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} logs --since=60m --follow {{ .Service.Name }}


key: viewServiceLogs

description:
A view service logs command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} logs --follow {{ .Service.Name }}


key: rebuildService

description:
A rebuild service command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} up -d --build {{ .Service.Name }}


key: recreateService

description:
A recreate service command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} up -d --force-recreate {{ .Service.Name }}


key: allLogs

description:
An all logs command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} logs --tail=300 --follow


key: viewAlLogs

description:
A view al logs command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} logs


key: dockerComposeConfig

description:
A docker compose config command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} config


key: checkDockerComposeConfig

description:
A check docker compose config command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} config --quiet


key: serviceTop

description:
A service top command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: {{ .DockerCompose }} top {{ .Service.Name }}


key: os

description:
OS settings
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default

default: open {{filename}}

default: open {{link}}


key: openCommand

description:
An open command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: openLinkCommand

description:
An open link command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: stats

description:
Statistic settings
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: graphs

description:
Graph settings
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: caption

description:
A caption
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: statPath

description:
A path
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: color

description:
A color
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: customCommands

description:
Custom commands
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: containers

description:
Container settings
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: name

description:
A name
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: attach

description:
Whether to attach
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: command

description:
A command
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: serviceNames

description:
Service names
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: items

description:
A service name
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


key: replacements

description:
Replacement settings
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


description:
A replacement group
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


description:
A replacement
https://github.com/jesseduffield/lazydocker/blob/master/docs/Config.md#default


description: The format of the color values is 'RRGGBB' where RR is the hex value for red, GG for green, and BB for blue.


key: elementId

description: The numeric id of the icon layout element based on the predefined layout selected.


key: condition

description: If set, then must be set to 'true' for this release


key: url

description: The URL to be referenced. For resources that require authentication, the URL must be HTTPS.

format: uri


key: style

description: Specifies the kind of web resource being accessed. Permitted values are 'Simple' and 'Feed'.

pattern: ^([sS]imple|[fF]eed)$

default: Simple


key: content

description: This member specifies how to extract content from the web response.


key: layout

description: The name of the layout for the page. The layout name should refer to one of the predefined page layouts.


key: iconBindings

description: Similar to textBindings, but used to select one of the web tile icons in icons list for each icon in the page. If there are no icon elements on the page, this member may be omitted.


key: textBindings

description: An array of objects corresponding to each page element that contains string content. Each binding object provides the numeric id of the page element based on the predefined layout selected, and the string value that it should contain.


key: conditions

description: For this release, this must contain an array with a single 'condition' object whose 'condition' is true, and whose 'icon' member specifies the name of the icon to be used.


key: icon

description: The name of the icon as specified in the 'icons' node.


description: The condition to be evaluated to determine whether to trigger the notification. The conditional expression has the syntax '<Operand1> <Operator> <Operand2>' or 'true'.


key: title

description: The text to use for the notification title. If longer than 20 characters, it will be truncated.


key: body

description: The text to use for the notification body. If longer than 20 characters, it will be truncated.


key: manifestVersion

description: Defines the contract between the web tile developer and the Microsoft Health app. It must be set to 1 for the current release.


key: name

description: Defines the name of the web tile.


key: description

description: Provides description about the web tile.


key: version

description: Indicates the version number of the web tile which will not be shown to users.


key: versionString

description: Indicates the web tile version as shown to users. If not provided, it displays the version.


key: author

description: Specifies the author of the web tile.


key: organization

description: Specifies the organization associated with the web tile.


key: contactEmail

description: Provides contact info of the web tile author. Used for administrative purposes and analytics by Microsoft Band team.

format: email


key: tileIcon

description: Specifies the location of the large tile icon.


key: badgeIcon

description: Specifies the location of the small tile icon. If not provided, the badging functionality is not enabled.


key: tileTheme

description: Specifies the custom theme colors for the web tile.


key: refreshIntervalMinutes

description: Specifies the desired data refresh interval, in minutes. Refresh intervals shorter than 15 will not be honored. If not provided, it defaults to 30.


key: resources

description: Each web tile must refer to one or more web resources. Each resource object describes a web data from which content for the tile will be extracted.


key: icons

description: All PNG icons used by the tile within its pages must be provided here.


key: pages

description: Each tile consists of one or more pages, as described by the objects in this array. Each page object specifies the layout and content of the page.


key: notifications

description: Creates notification that gets delivered when certain conditions are detected in the new web data.


description: API responses from the OpenWeather Road Risk API from https://openweathermap.org/api/road-risk

required: dt coord weather alerts


description: A slice definition for Ubuntu Chisel tool. For details, see https://github.com/canonical/chisel/tree/main#slice-definitions.

text: Some text

text: FIXME

until: mutate


key: package

description: The name of the package to use for the slice.


key: archive

description: The name of the archive to use for the slice. Archives are defined in the chisel.yaml file.


key: slices

description: Slice definitions for this package.

text: Some text

text: FIXME


description: The name of the slice part.

text: Some text

text: FIXME


key: essential

description: The name of the dependency slice part. The slice part is formatted as '<slice_name>_<slice_part>'.


key: mutate

description: A Starlark expression to modify the file contents.


key: contents

description: Files to include in the slice. Supports glob patterns.

text: Some text

text: FIXME


description: Path description.


key: make

description: Make this file or directory if it does not already exist.


key: mode

description: File permissions to use.


key: copy

description: Copy this file or directory from this location.


key: text

description: The contents of the file.


key: symlink

description: Make a symlink to this file or directory.


key: mutable

description: If true, the file is mutable.


key: until

description: Only keep this file until this stage.


key: arch

description: Only include this file on specific architectures.


description: Configuration for Dart's build system

default: cache

deprecationMessage: May be null or unreliable and should not be used.

enum: cache source


key: builderOptions

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.


key: autoApply

description: On which packages the builder is applied by default


key: buildTo

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


key: targetKey

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


key: builderKey

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


description: Configuration file for a CommandBox server

type: number string

default: /tuckey-status


key: trayOptionsItem

description: An object that represents a single tray menu item


key: label

description: Text of menu item


key: action

description: Action to perform when user clicks this menu item. 'openfilesystem', 'openbrowser', or 'stopserver'


key: url

description: Url to open for 'openbrowser' action


key: disabled

description: Turn menu item grey and nothing happens when clicking on it


key: image

description: Path to PNG image to display on menu item next to the label


key: hotkey

description: Keyboard shortcut to choose this menu item


key: path

description: Filesystem path to open for 'openfilesystem' action


key: items

description: Nested menu items


key: name

description: The name of the server


key: openBrowser

description: Controls whether browser opens by default when starting server


key: openBrowserURL

description: Override the URL to open when starting the server


key: startTimeout

description: The length of time in seconds to wait for the server to start


key: stopsocket

description: The port the server listens on to receive a stop command


key: debug

description: Enable debug level logging for server


key: trace

description: Enable trace level logging for server


key: console

description: Start the server in console mode instead of in the background


key: trayEnable

description: Control whether the server has an associated icon in the system tray


key: trayicon

description: Path to the server's tray icon


key: trayOptions

description: An array of custom menu items to be added to the server's tray menu


key: jvm

description: JVM Options


key: heapSize

description: The max heap size of the server


key: minHeapSize

description: The starting heap size for the server


key: args

description: Ad-hoc JVM args for the server such as -X:name


key: javaHome

description: Path to custom JRE. Default is the one that the CommandBox CLI is using


key: javaVersion

description: A Java installation ID. In its entirety, it has the form <version>_<type>_<arch>_<os>_<jvm-implementation>_<release>


key: web

description: Web Server Options


key: host

description: The default host name of the server


key: webroot

description: Webroot directory


key: directoryBrowsing

description: Enables file listing for directories with no welcome file


key: accessLogEnable

description: Enable web server access log


key: GZIPEnable

description: Enable GZip compression in HTTP responses


key: welcomeFiles

description: A comma-delimited list of files that you would like CommandBox to look for when a user hits a directory


key: aliases

description: Web aliases for the web server, similar to virtual directories


description: The key is the web-accessible virtual path and the value is the relative or absolute path to the folder the alias points to


key: errorPages

description: The error pages that CommandBox servers return. You can have a setting for each status code including a default error page to be used if no other setting applies


key: default

description: Path to default error page


description: The key is the status code integer and the value is a relative (to the web root) path to be loaded for that status code


key: HTTP

description: Configure the HTTP listener on the server


key: enable

description: Enable HTTP for this serer


key: port

description: HTTP port to use


key: SSL

description: Configure the HTTPS listener on the server


description: Enable HTTPS for this server


description: HTTPS port to use


key: certFile

description: Path to SSL cert file


key: keyFile

description: Path to SSL key file


key: keyPass

description: Password for SSL key file


key: AJP

description: Configure the AJP listener on the server


description: Enable AJP for this server


description: AJP port to use


key: rewrites

description: Configure URL Rewrites


description: Enable URL Rewrites on this server


key: logEnable

description: Enable Rewrite log file


key: config

description: Path to xml config file or .htaccess


key: statusPath

description: URL path to visit Tuckey status page like '/tuckey-status'


key: configReloadSeconds

description: Number of seconds to check rewrite config file for changes


description: Enable basic auth for this server


key: users

description: Users who can authenticate to basic auth


key: additionalProperties

description: The key is the user name and the value is the password.


key: app

description: Application Server Options


key: logDir

description: The folder path where the servlet out, rewrite, and access log are written to


key: libDirs

description: A comma-delimited list of directories from which CommandBox will load JARs


key: webConfigDir

description: Directory for Lucee/Railo web context


key: serverConfigDir

description: Directory for Lucee/Railo server context


key: webXML

description: Path to web.xml file


key: WARPath

description: Path to a local WAR archive or exploded WAR folder.  Mutually exclusive with cfengine.


key: cfengine

description: An Endpoint ID that resolves to a CF engine such as 'adobe' or 'lucee'. Include version as 'adobe@2016'


key: restMappings

description: Comma delimited list of paths to map to the CF engine's REST servlet such as '/rest/*,/api/*'


key: serverHomeDirectory

description: Path to folder where the server WAR will be expanded


key: sessionCookieSecure

description: Enable secure session cookies


key: sessionCookieHTTPOnly

description: Enable HTTP-only session cookies


key: runwar

description: These settings apply to the underlying Runwar library that starts servers


key: args

description: Ad-hoc options for the underlying Runwar library


key: AUTHOR

description: Author of the Trivia list.


key: CONFIG

description: The configuration for a trivia session.


description: Whether or not the bot gains points during the session.


key: delay

description: The maximum number of seconds permitted to answer a question, must be a positive number greater than or equal to 4.0.


description: Number of points required in order to win the trivia, must be a positive integer.


description: The payout multiplier, must be a positive number or zero.


description: Whether or not to reveal the answer when the question times out.


key: timeout

description: Number of seconds that need to pass until trivia stops due to no response, must be a positive number greater than 0.0.


description: Whether to hide the answers in spoilers when revealing the question's answers.


description: JSON schema fcor djLint's configuration file

profile: html

examples: {filename}:{line}: {code} {message} {match}

enum: html django jinja nunjucks handlebars golang angular


key: aggregator

description: Configuration settings for the function result aggregator.


key: batchSize

description: The maximum batch size for aggregations. If this value is reached before the 'flushTimeout', all values will be flushed.


key: flushTimeout

description: The aggregation duration. The aggregator will flush periodically based on this value.


key: functions

description: The list of functions the host should load.


key: functionTimeout

description: Value indicating the timeout duration for all functions.


key: watchDirectories

description: Set of shared code directories that should be monitored for changes to ensure that when code in these directories is changed, it is picked up by your functions


key: singleton

description: Configuration settings for Singleton lock behavior.


key: lockPeriod

description: The period that function level locks are taken for (they will auto renew).


key: listenerLockPeriod

description: The period that listener locks are taken for.


key: listenerLockRecoveryPollingInterval

description: The time interval used for listener lock recovery if a listener lock couldn't be acquired on startup.


key: lockAcquisitionTimeout

description: The maximum amount of time the runtime will try to acquire a lock.


key: lockAcquisitionPollingInterval

description: The interval between lock acquisition attempts.


key: healthMonitor

description: Configuration settings for the Functions host health monitor


key: enabled

description: Specifies whether the feature is enabled.


key: healthCheckInterval

description: The time interval between the periodic background health checks


key: healthCheckWindow

description: A sliding time window used in conjunction with the healthCheckThreshold setting.


key: healthCheckThreshold

description: Maximum number of times the health check can fail before a host recycle is initiated.


key: counterThreshold

description: The threshold at which a performance counter will be considered unhealthy.


key: http-extension

description: Configuration settings for 'http' triggers.

default: api


key: routePrefix

description: Defines the default route prefix that applies to all routes. Use an empty string to remove the prefix.


key: maxConcurrentRequests

description: Defines the the maximum number of http functions that will execute in parallel.


key: maxOutstandingRequests

description: Defines the maximum number of outstanding requests that will be held at any given time.


key: dynamicThrottlesEnabled

description: Indicates whether dynamic host counter checks should be enabled.


key: hsts

description: Configuration settings for Strict-Transport-Security


key: isEnabled

description: Indicates whether the hsts configuration should be applied


key: excludedHosts

description: Defines the list of host names that will not add the HSTS header.


key: includeSubDomains

description: Indicates whether the includeSubDomain parameter of the Strict-Transport-Security header should be enabled.


key: maxAge

description: Defines the max-age parameter of the Strict-Transport-Security header.


key: preload

description: Indicates whether the preload parameter of the Strict-Transport-Security header should be enabled.


key: customHeaders

description: Allows you to set custom headers in the HTTP response, ex. X-Content-Type-Options.


key: queues-extension

description: Configuration settings for 'queue' triggers.


key: maxPollingInterval

description: The maximum interval in milliseconds between queue polls.


key: batchSize

description: The number of queue messages to retrieve and process in parallel (per job function).


key: maxDequeueCount

description: The number of times to try processing a message before moving it to the poison queue


key: newBatchThreshold

description: The threshold at which a new batch of messages will be fetched. The default is batchSize/2.


key: visibilityTimeout

description: The visibility timeout that will be applied to messages that fail processing.


description: The maximum interval between queue polls. Minimum is 00:00:00.100 (100 ms).


description: The time interval between retries when processing of a message fails.


description: The number of queue messages that the Functions runtime retrieves simultaneously and processes in parallel. When the number being processed gets down to the `newBatchThreshold`, the runtime gets another batch and starts processing those messages. So the maximum number of concurrent messages being processed per function is `batchSize` plus `newBatchThreshold`. This limit applies separately to each queue-triggered function.


key: messageEncoding

description: This setting is only available in extension version 5.0.0 and higher. It represents the encoding format for messages.


key: durableTask-extension

description: Configuration settings for 'orchestration'/'activity' triggers.

default: DurableFunctionsHub

enum: Started Pending Completed Failed Terminated


key: hubName

description: Alternate task hub names can be used to isolate multiple Durable Functions applications from each other, even if they're using the same storage backend.


key: controlQueueBatchSize

description: The number of messages to pull from the control queue at a time.


key: controlQueueBufferThreshold

description: The number of control queue messages that can be buffered in memory at a time, at which point the dispatcher will wait before dequeuing any additional messages.


key: controlQueueVisibilityTimeout

description: The visibility timeout of dequeued control queue messages.


key: maxQueuePollingInterval

description: The maximum control and work-item queue polling interval in the hh:mm:ss format. Higher values can result in higher message processing latencies. Lower values can result in higher storage costs because of increased storage transactions.


key: partitionCount

description: The partition count for the control queue. May be a positive integer between 1 and 16.


key: trackingStoreConnectionStringName

description: The name of a connection string to use for the History and Instances tables. If not specified, the azureStorageConnectionStringName connection is used.


key: trackingStoreNamePrefix

description: The prefix to use for the History and Instances tables when trackingStoreConnectionStringName is specified. If not set, the default prefix value will be DurableTask. If trackingStoreConnectionStringName is not specified, then the History and Instances tables will use the hubName value as their prefix, and any setting for trackingStoreNamePrefix will be ignored.


key: useLegacyPartitionManagement

description: When set to false, uses a partition management algorithm that reduces the possibility of duplicate function execution when scaling out.


key: workItemQueueVisibilityTimeout

description: The visibility timeout of dequeued work item queue messages.


key: traceInputsAndOutputs

description: A value indicating whether to trace the inputs and outputs of function calls. The default behavior when tracing function execution events is to include the number of bytes in the serialized inputs and outputs for function calls. This behavior provides minimal information about what the inputs and outputs look like without bloating the logs or inadvertently exposing sensitive information. Setting this property to true causes the default function logging to log the entire contents of function inputs and outputs.


key: traceReplayEvents

description: A value indicating whether to write orchestration replay events to Application Insights.


key: topicEndpoint

description: The URL of an Azure Event Grid custom topic endpoint. When this property is set, orchestration life-cycle notification events are published to this endpoint. This property supports App Settings resolution.


key: keySettingName

description: The name of the app setting containing the key used for authenticating with the Azure Event Grid custom topic at EventGridTopicEndpoint.


key: publishRetryCount

description: The number of times to retry if publishing to the Event Grid Topic fails.


key: publishRetryInterval

description: The Event Grid publishes retry interval in the hh:mm:ss format.


key: publishEventTypes

description: A list of event types to publish to Event Grid. If not specified, all event types will be published.


key: maxConcurrentActivityFunctions

description: The maximum number of activity functions that can be processed concurrently on a single host instance.


key: maxConcurrentOrchestratorFunctions

description: The maximum number of orchestrator functions that can be processed concurrently on a single host instance.


key: useAppLease

description: When set to true, apps will require acquiring an app-level blob lease before processing task hub messages.


key: useGracefulShutdown

description: Enable gracefully shutting down to reduce the chance of host shutdowns failing in-process function executions.


key: maxEntityOperationBatchSize

description: The maximum number of entity operations that are processed as a batch. If set to 1, batching is disabled, and each operation message is processed by a separate function invocation.


key: cosmosDB-extension

description: Configuration settings for Azure Cosmos DB bindings and triggers.

enum: Gateway Direct

default: Gateway

enum: Https Tcp

default: Https


key: connectionMode

description: ConnectionMode to be used on the DocumentClients.


key: protocol

description: Protocol to be used on the DocumentClients.


key: leasePrefix

description: Lease prefix to use across all functions in an app.


key: applicationInsights

description: Configuration settings for Application Insights logging.


key: sampling

description: Configuration settings for Application Insights client-side adaptive sampling.


key: isEnabled

description: If true, client-side adaptive sampling is enabled.


key: maxTelemetryItemsPerSecond

description: The target rate that the adaptive algorithm aims for on each instance


key: id

description: The unique ID for this job host. Can be a lower case GUID with dashes removed


key: logger

description: Configuration settings for logging.

enum: Critical Debug Error Information None Trace Warning

default: Information


key: defaultLevel

description: The default level for logging. If a category level is not specified, this value is used.


key: categoryLevels

description: Log levels for specific categories.


key: tracing

description: Configuration settings for logging/tracing behavior.

enum: off error warning info verbose

default: verbose

enum: never always debugOnly

default: debugOnly


key: consoleLevel

description: The tracing level used for console logging.


key: fileLoggingMode

description: Value determining what level of file logging is enabled.


key: serviceBus

description: Configuration settings for 'serviceBus' triggers.


key: maxConcurrentCalls

description: The maximum number of concurrent calls to the callback the message pump should initiate.


key: prefetchCount

description: The default PrefetchCount that will be used by the underlying MessageReceiver.


key: autoRenewTimeout

description: The maximum duration within which the Service Bus message lock will be renewed automatically.


key: autoComplete

description: Specifies whether messages should be automatically completed after successful processing.


key: eventHub

description: Configuration settings for 'eventHub' triggers.


key: maxBatchSize

description: The maximum event count received per receive loop.


description: The default PrefetchCount that will be used by the underlying EventProcessorHost.


key: batchCheckpointFrequency

description: The number of batches to process before creating an EventHub cursor checkpoint


key: extensionBundle

description: Configuration settings for extension bundle


description: The id of the extension bundle


key: version

description: The version of the extension bundle.


key: languageWorker

description: Configuration settings for Language Workers.


key: workersDirectory

description: Specifies full path of the directory for language workers


key: logging

description: Configuration settings for logging.

default: Request

excludedTypes: Request


key: logLevel

description: Log levels for specific categories.


key: default


key: applicationInsights

description: Configuration settings for Application Insights logging.


key: samplingSettings

description: Configuration settings for Application Insights client-side adaptive sampling.


key: isEnabled

description: If true, client-side adaptive sampling is enabled.


key: maxTelemetryItemsPerSecond

description: The target rate that the adaptive algorithm aims for on each instance


key: evaluationInterval

description: The interval at which the current rate of telemetry is reevaluated.


key: initialSamplingPercentage

description: The initial sampling percentage applied at the start of the sampling process to dynamically vary the percentage.


key: samplingPercentageIncreaseTimeout

description: When the sampling percentage value changes, this property determines how soon afterwards Application Insights is allowed to raise sampling percentage again to capture more data.


key: samplingPercentageDecreaseTimeout

description: When the sampling percentage value changes, this property determines how soon afterwards Application Insights is allowed to lower sampling percentage again to capture less data.


key: minSamplingPercentage

description: As sampling percentage varies, this property determines the minimum allowed sampling percentage.


key: maxSamplingPercentage

description: As sampling percentage varies, this property determines the maximum allowed sampling percentage.


key: movingAverageRatio

description: In the calculation of the moving average, the weight assigned to the most recent value. Use a value equal to or less than 1. Smaller values make the algorithm less reactive to sudden changes.


key: excludedTypes

description: A semi-colon delimited list of types excluded from sampling. Recognized: Dependency, Event, Exception, PageView, Request, Trace.


key: includedTypes

description: A semi-colon delimited list of types that you want to be sampled. Recognized: Dependency, Event, Exception, PageView, Request, and Trace.


key: enableLiveMetrics

description: Enables live metrics collection.


key: enableLiveMetricsFilters

description: Enables live metrics filters.


key: enableDependencyTracking

description: Enables dependency tracking


key: enablePerformanceCountersCollection

description: Enables Kudu performance counters collection.


key: enableHttpTriggerExtendedInfoCollection

description: Enables or disables extended HTTP request information for HTTP triggers.


description: Enables or disables support of W3C distributed tracing protocol (and turns on legacy correlation schema). Enabled by default if enableHttpTriggerExtendedInfoCollection is true. If enableHttpTriggerExtendedInfoCollection is false, this flag applies to outgoing requests only, not incoming requests


key: enableResponseHeaderInjection

description: Enables or disables injection of multi-component correlation headers into responses. Enabling injection allows Application Insights to construct an Application Map to when several instrumentation keys are used.


key: agentEndpoint

description: The endpoint used to connect to the Application Insights Snapshot Debugger service.


key: captureSnapshotMemoryWeight

description: The weight given to the current process memory size when checking if there's enough memory to take a snapshot.


key: failedRequestLimit

description: The limit on the number of failed requests to request snapshots before the telemetry processor is disabled.


key: handleUntrackedExceptions

description: Enables or disables tracking of exceptions that aren't tracked by Application Insights telemetry.


key: isEnabled

description: Enables or disables snapshot collection.


key: isEnabledInDeveloperMode

description: Enables or disables snapshot collection is enabled in developer mode.


key: isEnabledWhenProfiling

description: Enables or disables snapshot creation even if the Application Insights Profiler is collecting a detailed profiling session.


key: isExceptionSnappointsEnabled

description: Enables or disables filtering of exceptions.


key: isLowPrioritySnapshotUploader

description: Determines whether to run the SnapshotUploader process at below normal priority.


key: maximumCollectionPlanSize

description: The maximum number of problems that we can track at any time.


key: maximumSnapshotsRequired

description: The maximum number of snapshots collected for a single problem.


key: problemCounterResetInterval

description: How often to reset the problem counters in a range from one minute to seven days.


key: provideAnonymousTelemetry

description: Determines whether to send anonymous usage and error telemetry to Microsoft. This telemetry may be used if you contact Microsoft to help troubleshoot problems with the Snapshot Debugger


key: reconnectInterval

description: How often we reconnect to the Snapshot Debugger endpoint. Allowable range is one minute to one day.


key: shadowCopyFolder

description: Specifies the folder to use for shadow copying binaries. If not set, the folders specified by the following environment variables are tried in order: Fabric_Folder_App_Temp, LOCALAPPDATA, APPDATA, TEMP.


key: shareUploaderProcess

description: If true, only one instance of SnapshotUploader will collect and upload snapshots for multiple apps that share the InstrumentationKey. If set to false, the SnapshotUploader will be unique for each (ProcessName, InstrumentationKey) tuple.


key: snapshotInLowPriorityThread

description: Determines whether or not to process snapshots in a low IO priority thread.


key: snapshotsPerDayLimit

description: The maximum number of snapshots allowed in one day (24 hours). This limit is also enforced on the Application Insights service side.


key: snapshotsPerTenMinutesLimit

description: The maximum number of snapshots allowed in 10 minutes. Although there is no upper bound on this value, exercise caution increasing it on production workloads because it could impact the performance of your application.


key: tempFolder

description: Specifies the folder to write minidumps and uploader log files. If not set, then %TEMP%\Dumps is used.


key: thresholdForSnapshotting

description: How many times Application Insights needs to see an exception before it asks for snapshots.


key: uploaderProxy

description: Overrides the proxy server used in the Snapshot Uploader process. You may need to use this setting if your application connects to the internet via a proxy server. The Snapshot Collector runs within your application's process and will use the same proxy settings.


key: fileLoggingMode

description: Value determining what level of file logging is enabled.


key: managedDependency

description: Managed dependency is a feature that is currently only supported with PowerShell based functions. It enables dependencies to be automatically managed by the service.


key: enabled

description: If true, the requirements.psd1 file is processed


key: retry

description: Retry policy of function execution failures at the app level. Retry policy applies to all the functions in the function app.

enum: exponentialBackoff fixedDelay

default: exponentialBackoff


key: strategy

description: Retry strategy to use for retrying function executions


key: maxRetryCount

description: The maximum number of retries allowed per function execution. -1 means to retry indefinitely.


key: delayInterval

description: Value indicating the delayInterval for function execution retries when using FixedDelay strategy.


key: minimumInterval

description: Value indicating the minimumInterval for function execution retries when using ExponentialBackoff strategy.


key: maximumInterval

description: Value indicating the maximumInterval for function execution retries when using ExponentialBackoff strategy.


key: customHandler

description: Configuration settings for Custom Handler.


key: description

description: Configuration settings for Custom Handler process


key: defaultExecutablePath

description: Name or path to the Custom Handler process


key: workingDirectory

description: WorkingDirectory to be used by the Custom Handler process. If not set, defaults to function app root folder.


key: arguments

description: Arguments to be passed to the Custom Handler process. Can use environment variables following pattern %envVarName%


key: enableForwardingHttpRequest

description: Forward HttpTrigger request to the custom handler


key: watchFiles

description: An array of one or more names of files that are monitored for changes that require your app to restart. This guarantees that when code in these files are changed, the updates are picked up by your functions


key: version

description: The version of the Azure Functions host.json schema. This is NOT the version of the Azure Functions host.


key: from

description: The sender's email address across all functions.


key: serviceBus

description: Configuration settings for 'serviceBus' triggers.


key: prefetchCount

description: The default PrefetchCount that will be used by the underlying MessageReceiver.


key: messageHandlerOptions

description: The options that will be used for the message handler registered with the MessageReceiver.


key: maxConcurrentCalls

description: The maximum number of concurrent calls to the callback the message pump should initiate.


key: maxAutoRenewDuration

description: The maximum duration within which the Service Bus message lock will be renewed automatically.


key: autoComplete

description: Value determining whether messages will be completed automatically, or whether the function will take responsibility message completion.


key: maxConcurrentSessions

description: The maximum number of sessions that can be handled concurrently per scaled instance.


key: maxMessageCount

description: The maximum number of messages sent to the function when triggered.


key: operationTimeout

description: A time span value expressed in hh:mm:ss.


description: Whether the trigger should automatically call complete after processing, or if the function code will manually call complete.


key: eventHubs

description: Configuration settings for 'eventHub' triggers.

enum: amqpTcp amqpWebSockets

default: amqpTcp

enum: fromStart fromEnd fromEnqueuedTime

default: fromStart

enum: exponential fixed

default: exponential


key: targetUnprocessedEventThreshold

description: The target number of unprocessed events per worker for Event Hub-triggered functions. This is used in target-based scaling to override the default scaling threshold inferred from maxEventBatchSize.


key: maxEventBatchSize

description: The maximum number of events that will be included in a batch for a single invocation.


key: batchCheckpointFrequency

description: The number of batches to process before creating a checkpoint for the Event Hub.


description: The number of events that will be eagerly requested from Event Hubs and held in a local cache to allow reads to avoid waiting on a network operation.


key: transportType

description: The protocol and transport that is used for communicating with Event Hubs.


key: webProxy

description: The proxy to use for communicating with Event Hubs over web sockets. A proxy cannot be used with the amqpTcp transport.


key: customEndpointAddress

description: The address to use when establishing a connection to Event Hubs, allowing network requests to be routed through an application gateway or other path needed for the host environment.


key: type

description: The location in the event stream to start processing when a checkpoint does not exist in storage. Applies to all partitions.


key: enqueuedTimeUtc

description: Specifies the enqueued time of the event in the stream from which to start processing. When initialOffsetOptions/type is configured as fromEnqueuedTime, this setting is mandatory. Supports time in any format supported by DateTime.Parse(), such as 2020-10-26T20:31Z.


key: mode

description: The approach to use for calculating retry delays. Exponential mode will retry attempts with a delay based on a back-off strategy where each attempt will increase the duration that it waits before retrying.


key: tryTimeout

description: The maximum duration to wait for an Event Hubs operation to complete, per attempt.


key: delay


key: maxDelay

description: The maximum delay to allow between retry attempts.


key: maxRetries

description: The maximum number of retry attempts before considering the associated operation to have failed.


description: The number of batches to process before creating an EventHub cursor checkpoint.


key: eventProcessorOptions

description: Configuration on processing event hub events.


key: maxBatchSize

description: The maximum event count received per receive loop.


key: prefetchCount

description: The default PrefetchCount that will be used by the underlying EventProcessorHost.


description: The location in the event stream from which to start processing when a checkpoint doesn't exist in storage.


description: The default prefetch that will be used by the underlying EventProcessorHost.


description: The number of event batches to process before creating an EventHub cursor checkpoint.


key: maxDegreeOfParallelism

description: The number of concurrent invocations allowed for each blob-triggered function.


key: maxDequeueCount

description: The number of times to try processing a message before moving it to the poison queue.


key: concurrency

description: Configuration settings for dynamic concurrency


key: dynamicConcurrencyEnabled

description: Enables or disables dynamic concurrency for function apps.


key: snapshotPersistenceEnabled

description: Enables or disables the learned concurrency values persisting in storage.


key: cvars

description: CVar name


key: commands

description: Console command name


key: value

description: The default value of the CVar


key: items

description: This indicates where the assets are stored

default: Assets


description: This indicates where the code is stored

default: Code


key: name

description: This indicates the project name


key: engine

description: This indicates which engine version will be used


key: path

description: Required plugin's name

examples: CryDefaultEntities CrySensorSystem CryPerceptionSystem CryUserAnalytics CryOSVR CryOculusVR CryOpenVR CryLobby


key: type

description: EPluginType::Native if it's a C++ plugin, EPluginType::Managed if it's a C# one


description: Arguments that has to be passed to the command. Leave empty if it has not parameters


key: Root

description: The 'RootConfig' object defines the global properties that are used to drive the underlying database-driven CDC-oriented code-generation.

enum: String Int Long Guid

enum: None PascalCase SnakeKebabToPascalCase

enum: SystemText Newtonsoft

enum: None HostedService Service

enum: NameOnly NameAndKey NameAndTableKey

enum: None Absolute Relative RelativeOrAbsolute


key: schema

description: This is used as the default 'Schema' for all child objects. Defaults to 'dbo' (literal).


key: cdcSchema

description: Defaults to 'NTangle' (literal).


key: cdcSchemaCreate

description: Defaults to 'false'.


key: versionTrackingTable

description: Defaults to 'VersionTracking' (literal).


key: cdcEnable

description: Defaults to 'false'. This option can be overridden for each underlying table referenced.


key: identifierMapping

description: Where set to 'true' each underlying 'Table' and corresponding 'Join' must set 'IdentifierMapping' explicitly.


key: identifierMappingType

description: Defaults to 'String'.


key: identifierMappingTable

description: Defaults to 'IdentifierMapping' (literal).


key: identifierMappingStoredProcedure

description: Defaults to 'spIdentifierMappingCreate' (literal).


key: isDeletedColumn

description: Defaults to 'IsDeleted'.


key: autoDotNetRename

description: Defaults to 'SnakeKebabToPascalCase' which will remove any underscores or hyphens separating each word and capitalize the first character of each; e.g. 'internal-customer_id' would be renamed as 'InternalCustomerId'. The 'PascalCase' option will capatilize the first character only.


key: jsonSerializer

description: Defaults to 'SystemText'.


key: service

description: Defaults to 'None'. A 'HostedService' is an 'IHostedService' implementation enabling long-running execution; whereas, 'Service' is intended for self-managed execution.


key: eventSubjectRoot

description: Used to enable the sending of messages to the likes of EventHubs, Service Broker, Kafka, etc.


key: eventSubjectFormat

description: Defaults to 'NameOnly'.


key: eventActionFormat

description: Defaults to 'None' (no formatting required, i.e. as-is).


key: eventSourceKind

description: Defaults to 'Relative' (being a relative path).


key: eventSourceRoot

description: The event source is only updated where an 'EventSourceKind' is not 'None'.


key: eventSourceFormat

description: Defaults to 'NameAndTableKey' (being the child 'Cdc.ModelName' appended with the corresponding table key).


key: eventTypeRoot

description: Used to enable the sending of messages to the likes of EventHubs, Service Broker, Kafka, etc. Defaults to 'EventSubjectRoot'.


key: outbox

description: Defaults to 'false'.


key: outboxSchema

description: Defaults to 'Outbox' (literal).


key: outboxSchemaCreate

description: Defaults to 'false'.


key: outboxTable

description: Defaults to 'EventOutbox' (literal).


key: outboxEnqueueStoredProcedure

description: Defaults to 'spEventOutboxEnqueue' (literal).


key: outboxDequeueStoredProcedure

description: Defaults to 'spEventOutboxDequeue' (literal).


key: pathBase

description: Defaults to 'AppName' (runtime parameter). For example 'Avanade.Application'.


key: pathDatabase

description: Defaults to 'PathBase' + '.Database' (literal). For example 'Avanade.Application.Database'.


key: pathDatabaseSchema

description: Defaults to 'PathDatabase' + '/Schema' (literal). For example 'Avanade.Application.Database/Schema'.


key: pathDatabaseMigrations

description: Defaults to 'PathDatabase' + '/Migrations' (literal). For example 'Avanade.Application.Database/Migrations'.


key: pathDotNetPublisher

description: Defaults to 'PathBase' + '.Publisher' (literal). For example 'Avanade.Application.Publisher'.


key: namespaceBase


key: namespacePublisher

description: Defaults to 'NamespaceBase' + '.Publisher' (literal). For example 'Avanade.Application.Publisher'.


key: namespaceOutbox

description: Defaults to 'NamespacePublisher'.


key: tables

description: A 'Table' object provides the primary database table configuration for Change Data Capture (CDC), including multiple child table joins to form a composite entity.


key: Table

description: The 'Table' object enables the definition of the primary table, one-or-more child tables and their respective join relationships, to enable Change Data Capture (CDC) event publishing. The 'IncludeColumns' and 'ExcludeColumns' provide a shorthand to include or exclude selected columns; with the 'AliasColumns' providing a means to rename where required.


key: schema

description: Defaults to 'Root.Schema'.


key: table

description: Defaults to 'Name'. This is used to specify the actual underlying database table name (required where the 'Name' has been changed to enable uniqueness).


key: alias

description: Will automatically default where not specified; for example a table named 'Person' will default to 'p'.


key: includeColumns

description: Where not specified this indicates that all 'Columns' are to be included.


key: excludeColumns

description: Where not specified this indicates no 'Columns' are to be excluded.


key: aliasColumns

description: Each alias value should be formatted as 'Column' + '^' + 'Alias'; e.g. 'PCODE^ProductCode'.


key: executeStoredProcedure

description: Defaults to 'sp' (literal) + 'Name' + 'BatchExecute' (literal); e.g. 'spNameBatchExecute'.


key: completeStoredProcedure

description: Defaults to 'sp' (literal) + 'Name' + 'BatchComplete' (literal); e.g. 'spNameBatchComplete'.


key: cdcSchema

description: Defaults to 'Root.CdcSchema'.


key: batchTrackingTable

description: Defaults to 'Name' + 'BatchTracking' (literal).


key: cdcEnable

description: Defaults to 'false'. This option can be overridden for each underlying table referenced.


key: model

description: Defaults to 'Name'.


key: orchestratorCtorParams

description: Each constructor parameter should be formatted as 'Type' + '^' + 'Name'; e.g. 'IConfiguration^Config'. Where the 'Name' portion is not specified it will be inferred.


key: database

description: Defaults to 'IDatabase'.


key: includeColumnsOnDelete

description: Where a column is not specified in this list its corresponding .NET property will be automatically cleared by the 'CdcDataOrchestrator' as the data is technically considered as non-existing.


key: service

description: Defaults to 'Root.Service'. A 'HostedService' is an 'IHostedService' implementation enabling long-running execution; whereas, 'Service' is intended for self-managed execution.


key: excludeColumnsFromETag

description: Defaults to 'Root.CdcExcludeColumnsFromETag'.


key: partitionKey

description: A partition key can be specified using either 'PartitionKey' or 'PartitionKeyColumns'.


key: partitionKeyColumns


key: eventSource

description: Defaults to 'Schema' + '/' (literal) + 'Name' (as lowercase). Note: when used in code-generation the 'Root.EventSourceRoot' will be prepended where specified.


key: eventSourceFormat

description: Defaults to 'Root.EventSourceFormat'.


key: eventSubject

description: Defaults to 'ModelName'. Note: when used in code-generation the 'Root.EventSubjectRoot' will be prepended where specified.


key: eventSubjectFormat

description: Defaults to 'Root.EventSubjectFormat'.


key: eventType

description: Defaults to 'ModelName'. Note: when used in code-generation the 'Root.EventTypeRoot' will be prepended where specified.


key: identifierMapping

description: This indicates whether to create a new 'GlobalId' property on the _entity_ to house the global mapping identifier to be the reference outside of the specific database realm as a replacement to the existing primary key column(s).


key: identifierName


key: isDeletedColumn

description: Defaults to 'Root.ColumnIsDeleted'.


key: joins

description: A 'Join' object provides the configuration for a table join.


key: where

description: A 'Where' object provides the configuration for a table where clause.


key: Join

description: The 'Join' object defines a join to another (or same) table within the logical CDC entity.  The 'IncludeColumns' and 'ExcludeColumns' provide a shorthand to include or exclude selected columns; with the 'AliasColumns' providing a means to rename where required.

enum: Cdc Inner Left Right Full

enum: OneToMany OneToOne


key: name

description: A unique name is required where the same 'Table' is referenced more than once within a logical CDC entity. However, generally, this will represent the unique name of the table within the database.


key: schema

description: Defaults to 'Cdc.Schema'; i.e. same schema.


key: table

description: Defaults to 'Name'. This is used to specify the actual underlying database table name (required where the 'Name' has been changed to enable uniqueness).


key: alias

description: Will automatically default where not specified.


key: type

description: Defaults to 'Cdc'. The 'Cdc' value indicates this is a related secondary table (within a logical CDC entity) that also has Change Data Capture turned on and equally needs to be monitored for changes.


key: joinTo

description: Defaults to parent 'Table.Name'.


key: joinCardinality

description: Defaults to 'OneToMany'. This represents the Parent ('JoinTo') to child (_this_) relationship.


key: cdcEnable

description: Defaults to 'false'. This option can be overridden for each underlying table referenced.


key: querySizeMultiplier

description: Defaults to '1.0'. This is applied to the execute stored procedure '@MaxQuerySize' parameter to allow tailoring on the join query ('TOP') sizes to optimize selection. Must be greater than zero and less than or equal to 100.


key: includeColumns

description: Where not specified this indicates that all 'Columns' are to be included.


key: excludeColumns

description: Where not specified this indicates no 'Columns' are to be excluded.


key: aliasColumns

description: Each alias value should be formatted as 'Column' + '^' + 'Alias'; e.g. 'PCODE^ProductCode'


key: model

description: Defaults to 'Name'.


key: property

description: Defaults to 'Model' where 'JoinCardinality' is 'OneToOne'; otherwise, it will be the 'Model' pluralized.


key: includeColumnsOnDelete

description: Where a column is not specified in this list its corresponding .NET property will be automatically cleared by the 'CdcDataOrchestrator' as the data is technically considered as non-existing.


key: excludeColumnsFromETag

description: Defaults to 'CodeGeneration.CdcExcludeColumnsFromETag'.


key: identifierMapping

description: This indicates whether to create a new 'GlobalId' property on the _entity_ to house the global mapping identifier to be the reference outside of the specific database realm as a replacement to the existing primary key column(s).


key: identifierName


key: JoinOn

description: The 'JoinOn' object defines the join on characteristics for a 'Join' object.


key: toColumn

description: Defaults to 'Name'; i.e. assumes same name.


key: JoinMapping

description: The 'JoinMapping' object defines one or more related table identifier mappings.

required: name table


key: schema

description: Defaults to the owning (parent) table schema.


key: Where

description: This should only be used where the column value is largely immutable; otherwise, unintended side-effects may occur. _NTangle_ uses the condition explictily and does not attempt to handle value change to infer creation or deletion of data as a result of the underlying change; as such, this should be used cautiously. Note that the 'where' is applied when querying the 'cdc.fn_cdc_get_all_changes_...' function, not the underlying table itself.

enum: ISNULL ISNOTNULL

enum: EQ NE LT LE GT GE LIKE


key: name

description: The column name.


key: nullable

description: This enables statements such as 'WHERE (COL IS NULL)' or 'WHERE (COL IS NULL OR COL = VALUE)' (where .


key: operator

description: Defaults to 'EQ' where 'Value' is specified.


key: value

description: This must be valid formatted/escaped SQL.


key: TableMapping

description: The 'TableMapping' object defines one or more related table identifier mappings.


key: Eval

description: Script that is executed by passing a string to the host-provided eval function.

default: MyCode


key: Function

description: Script that is executed by passing a string to the 'Function' constructor.

default: LibraryCode


key: ScriptBlock

description: Script that is executed by passing a string to the 'setTimeout', 'setImmediate', or 'setInterval' functions.

default: UnrelatedCode


key: MyCode

description: An array of urls or files that are classified as 'MyCode'.


key: Libraries

description: An array of urls or files that are classified as 'LibraryCode'.


key: Unrelated

description: An array of urls or files that are classified as 'UnrelatedCode'.


description: A file extension


description: The main configuration file for the OSS-Review-Toolkit (ORT). A full list of all available options can be found at https://github.com/oss-review-toolkit/ort/blob/main/model/src/main/resources/reference.yml.

§ref: #/definitions/HttpFileStorage

required: url username

enum: HINT WARNING ERROR

enum: ARTIFACT VCS

enum: clearlyDefined http local postgres


description: codeship-services.yml is where you configure each service you need to run your CI/CD builds with CodeShip.


key: ExternalService

description: The definition of a service in a CodeShip Pro build, which can have steps run on it or have other services depend on it


description: If true, the docker socket will be exposed in this service.


key: build

description: How to build the image for this service. Mutually exclusive with 'image'. Can either be just a path containing a Dockerfile, or a build definition.


key: cached

description: Whether the image for this service should be rebuilt from scratch for each run, or if the latest build of the service's image from the configured cache branch (defaulting to 'master') should be used.


key: command

description: The command to run when launching the service, overriding the 'CMD' in the image. Optional.


description: The branch to use for caching. Defaults to 'master'


description: The name of another defined service that provides the Docker configuration for building and running this service. Optional.


key: dockerfile

description: A specific Dockerfile to use, rather than the one in the build context


description: The location of a Docker configuration file encrypted by Jet to be used with building and running this service. Optional.


description: The location of one or more files, encrypted with Jet, containing environment variables to be made available to this service and steps running on it. Optional.


description: A list of encrypted key/value pairs to be used in the environment for this service and steps running on it. Optional.


description: The location of one or more files containing environment variables to be made available to this service and steps running on it. Optional.


key: environment

description: Either a map of key/value pairs or a list of 'KEY=VALUE' pairs to be used in the environment for this service and steps running on it. Optional.


key: image

description: A pre-existing image to use for this service. Mutually exclusive with 'build'


description: A list of other services that this service depends on. Use this instead of 'links'


key: ports

description: A list of ports that should be exposed to other services. The ports should be defined like '9999', as strings


key: volumes

description: A list of origin/destination pairs of directories or files relative to the build context and where they should be mounted in the service. Optional.


description: A list of other services which should have their defined volumes mounted into this service as well. Optional.


key: externalBuild

description: Configuration of how to build the image for this service


key: path

description: DEPRECATED: Use 'context' instead.


description: DEPRECATED: Use 'dockerfile' instead


description: The output image name for this image. Optional.


key: context

description: The directory used as the Docker build context. Defaults to the same directory as the codeship-services.yml file


description: A specific Dockerfile to use rather than the 'Dockerfile' present in the build context. Optional.


key: args

description: Build args to pass to Docker. Optional.


description: One or more files, encrypted with Jet, to have their contents decrypted and passed to Docker as build args. Optional.


description: A list of encrypted key/value pairs to be used as build args to Docker. Optional.


description: A representation of a single-file manifest representing an app in the OWC. v1.0.0

enum: msix msi appx exe zip inno nullsoft wix burn pwa

enum: user machine

enum: interactive silent silentWithProgress

enum: install uninstallPrevious

default: singleton

const: singleton

required: PackageIdentifier PackageVersion PackageLocale Publisher PackageName License ShortDescription Installers ManifestType ManifestVersion


key: PackageIdentifier

description: The package unique identifier


key: PackageVersion

description: The package version


key: Locale

description: The package meta-data locale


key: Url

description: Optional Url type


key: Tag

description: Package moniker or tag


key: Channel

description: The distribution channel


key: Platform

description: The installer supported operating system


key: MinimumOSVersion

description: The installer minimum operating system version


key: InstallerType

description: Enumeration of supported installer types


key: Scope

description: Scope indicates if the installer is per user or per machine


key: InstallModes

description: List of supported installer modes


key: Silent

description: Silent is the value that should be passed to the installer when user chooses a silent or quiet install


key: SilentWithProgress

description: SilentWithProgress is the value that should be passed to the installer when user chooses a non-interactive install


key: Interactive

description: Interactive is the value that should be passed to the installer when user chooses an interactive install


key: InstallLocation

description: InstallLocation is the value passed to the installer for custom install location. <INSTALLPATH> token can be included in the switch value so that winget will replace the token with user provided path


key: Log

description: Log is the value passed to the installer for custom log file path. <LOGPATH> token can be included in the switch value so that winget will replace the token with user provided path


key: Upgrade

description: Upgrade is the value that should be passed to the installer when user chooses an upgrade


key: Custom

description: Custom switches will be passed directly to the installer by winget


key: InstallerSuccessCodes

description: List of additional non-zero installer success exit codes other than known default values by winget


key: UpgradeBehavior

description: The upgrade method


key: Commands

description: List of commands or aliases to run the package


key: Protocols

description: List of protocols the package provides a handler for


key: FileExtensions

description: List of file extensions the package could support


key: WindowsFeatures

description: List of Windows feature dependencies


key: WindowsLibraries

description: List of Windows library dependencies


key: PackageDependencies

description: List of package dependencies from current source


key: ExternalDependencies

description: List of external package dependencies


key: PackageFamilyName

description: PackageFamilyName for appx or msix installer. Could be used for correlation of packages across sources


key: ProductCode

description: ProductCode could be used for correlation of packages across sources


key: Capabilities

description: List of appx or msix installer capabilities


key: RestrictedCapabilities

description: List of appx or msix installer restricted capabilities


key: Architecture

description: The installer target architecture


key: InstallerUrl

description: The installer Url


description: Sha256 is required. Sha256 of the installer


SignatureSha256 is recommended for appx or msix. It is the sha256 of signature file inside appx or msix. Could be used during streaming install if applicable


key: PackageLocale

description: The package meta-data locale


key: Publisher

description: The publisher name


key: PublisherUrl

description: The publisher home page


key: PublisherSupportUrl

description: The publisher support page


key: PrivacyUrl

description: The publisher privacy page or the package privacy page


key: Author

description: The package author


key: PackageName

description: The package name


key: PackageUrl

description: The package home page


key: License

description: The package license


key: LicenseUrl

description: The license page


key: Copyright

description: The package copyright


key: CopyrightUrl

description: The package copyright page


key: ShortDescription

description: The short package description


key: Description

description: The full package description


key: Moniker

description: The most common package term


key: Tags

description: List of additional package search terms


key: ManifestType

description: The manifest type


key: ManifestVersion

description: The manifest syntax version


key: name

description: Name of the app. Defaults to directory name.


key: type

description: Type of the app.

enum: static function service


key: env

description: Environment variables common for all operations.


key: dir

description: Working directory of the app where all commands will be run. Defaults to location of this yaml. All other dirs will be relative to this one.


key: url

description: External URL of the app.


description: Path redirect rewrites URL to specified path. URL path from 'url' field will be stripped and replaced with value below.


key: needs

description: Application dependencies to inject.


key: run

description: Run config used for dev builds during run.


key: cdn

description: CDN settings.


key: routing

description: Routing type. Defaults to 'react'.

enum: react gatsby disabled


description: Remove trailing slash with permanent redirect. Currently used only for deployments. Defaults to 'true' when gatsby routing is used, 'false' otherwise.


Static application basic authentication config. Currently used only for deployments.


key: build

description: Static application build config used for deployment builds.


key: deploy

description: Static deploy config.


key: private

description: Marks app as private - won't allow unauthenticated access.


description: Service application build config used for deployment builds.


key: container

description: Service application container config used for docker based deployments/runs.


description: Service deploy config.


key: scheduler

description: Service scheduler config.


key: runtime

description: The runtime in which the function is going to run, refer to cloud provider docs for possible options.


key: entrypoint

description: Name of the function that will be executed when the function is triggered. Not all deployment plugins support it. Defaults to application name.


description: Function application build config used for deployment builds.


description: Function deploy config.


key: package

description: Function package config.


description: Function scheduler config.


key: plugin

description: Run plugin override. Defaults to first supported plugin available.


key: command

description: Command to be run to for dev mode.


key: port

description: Port override, by default just assigns next port starting from listen-port.


key: env

description: Additional environment variables available local run.


description: Deploy plugin override. Defaults to first supported plugin available.


description: Minimum scale of container deployment (used if deployment uses a container).


description: Maximum scale of container deployment (used if deployment uses a container).


key: timeout

description: Execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period.


key: patterns

description: File/dir patterns to exclude (or force include if starts with '!').


description: Additional environment variables.


description: CPU limit of container deployment. 1.0 means 1 full core of CPU will be used.


description: Memory limit in MiB of container deployment.


description: Minimum scale of container deployment.


description: Maximum scale of container deployment.


description: Service application container config used for docker based deployments.


key: cron

description: Scheduler cron, e.g. */30 * * * * runs every 30 minutes.


key: name

description: Name of cron (just for information purpose).


key: method

description: HTTP method to use. Defaults to 'GET'.

enum: GET POST HEAD PUT DELETE PATCH OPTIONS


key: path

description: Path to call in current app url.


key: headers

description: Additional headers to use for this call.


description: Memory limit in MiB of function deployment.


description: Package patterns to exclude (or force include if starts with '!').


key: realm

description: Basic auth realm name, defaults to 'restricted'.


key: users

description: Basic auth users in form of `user: password` where password is either in plain text or in a form of apr1 hash (used by htpasswd).


description: Additional environment variables available during build.


description: Command to be run to generate output files.


key: dir

description: Output dir to where static files end up.


key: image

description: Docker image to use. If specified, will try to pull this image if skip-build is enabled.


description: Skip this image build phase. If enabled, requires image to be either present on docker host or custom image to be possible to pull.


description: Skip this image dependencies pull phase. As a result, doesn't check for newer versions of tagged dependencies. Useful if dependencies do not exist outside of local docker.


description: Docker build-args.


key: context

description: Docker context directory, relative to application dir.


key: dockerfile

description: Dockerfile to use, relative to context path. Defaults to 'Dockerfile'.


description: Output dir to where built files end up.


description: Docker container port to use.


description: Docker command (CMD) to override.


key: entrypoint

description: Docker entrypoint (ENTRYPOINT) to override.


key: examples

description: renders the gallery card

type: functional

displayName: Card Template

displayName: Display name

displayName: Items per row

type: table

displayName: Select table


key: params

description: Main heading of the web template


description: No of items to be displayed per row


key: type

description: The web template type. Use 'functional' for custom site components and 'layout' for custom layouts.

enum: functional layout


key: displayName

description: The display name of the web template


key: description

description: The description of the web template


key: tables

description: An array of table logical names that are used in the web template


description: The editable properties of the web template. These will be customizable in Studio

examples: name count specifiedTable

examples:
Display name
Items per row
Selected table


key: id

description: The id of the param. This correlates with the liquid tag's key for this property


description: The label displayed when editing a property in Studio. If no displayName is given, the label will fallback on the id


description: The description to be displayed in the tooltip when editing a property in Studio. If no description is given, no tooltip will be displayed

examples:
Main heading of the web template
No of items to be displayed per row


description: Used to specify a property that correlates to a table's logical name


description: Main heading of the web template


description: No of items to be displayed per row


description: A tool for mock local requests or proxy remote requests.

default: mocks

required: mockFileName routes


key: mockFileName

description: Root of mock files


key: requestHeaders

description: Custom request header


key: responseHeaders

description: Custom response header


key: parseBody

description: Parse post body by express.json()


key: routes

description: Rules for proxy and mock


description: Rule of Matching route


key: path

description: Where Mock result file located


key: ignore

description: Whether to ignore this rule, generally used for remote interfaces instead of mock in the local


key: delay

description: How many milliseconds are delayed to return a request, general used for control the request sequence


key: validate

description: Validate params in body by key and typeof value


description: Configuration file defining a loot table for a data pack for Minecraft.

enum: minecraft:constant minecraft:uniform minecraft:binomial minecraft:score

type: number object

type: integer object

type: string object

enum: fixed context

const: fixed

const: context

enum: minecraft:empty empty minecraft:entity entity minecraft:block block minecraft:chest chest minecraft:fishing fishing minecraft:gift gift minecraft:advancement_reward advancement_reward minecraft:barter barter minecraft:command command minecraft:selector selector minecraft:advancement_entity advancement_entity minecraft:generic generic

enum: minecraft:item minecraft:tag minecraft:loot_table minecraft:group minecraft:alternatives minecraft:sequence minecraft:dynamic minecraft:empty


description: The number provider type.


key: then

description: A constant value.


key: value

description: The exact value.


description: A random number following a uniform distribution between two values (inclusive).


key: min

description: The minimum value.


key: max

description: The maximum value.


description: A random number following a binomial distribution.


key: n

description: The amount of trials.


key: p

description: The probability of success on an individual trial.


description: A scoreboard value.


key: target

description: Scoreboard name provider.


key: type

description: Resource location.


key: name

description: A UUID or player name.


key: score

description: The scoreboard objective.


key: scale

description: Scale to multiply the score before returning it.


key: functions

description: Applies functions to all item stacks produced by this table. Functions are applied in order, so for example looting_enchant must be after set_count to work correctly.

type: object


key: additionalProperties

description: A function.


key: function

description: Namespaced ID of the function to apply.


key: conditions

description: Determines conditions for this function to be applied. If multiple conditions are specified, all must pass.


description: A function.


key: condition

description: Namespaced ID of condition.


key: pools

description: A list of all pools for this loot table. Each pool used generates items from its list of items based on the number of rolls. Pools are applied in order.


key: items

description: A pool.


description: Determines conditions for this pool to be used. If multiple conditions are specified, all must pass.


description: A condition.


description: Applies functions to all item stacks produced by this pool. Functions are applied in order, so for example looting_enchant must be after set_count to work correctly.


description: A function.


description: A condition.


key: rolls

description: Specifies the number of rolls on the pool.


description: Specifies the number of bonus rolls on the pool per point of luck. Rounded down after multiplying.


key: entries

description: A list of all things that can be produced by this pool. One entry is chosen per roll as a weighted random selection from all entries without failing conditions.


description: An entry.


description: Determines conditions for this entry to be used. If multiple conditions are specified, all must pass.


description: Applies functions to the item stack or item stacks being produced. Functions are applied in order, so for example looting_enchant must be after set_count to work correctly.


description: Namespaced ID of the function to apply.


description: Namespaced ID type of entry.


key: expand

description: For type 'tag', if set to true, it chooses one item of the tag, each with the same weight and quality. If false, it generates one of each of the items in the tag.


key: weight

description: Determines how often this entry is chosen out of all the entries in the pool. Entries with higher weights are used more often (chance is this entry's weight⁄total of all considered entries' weights).


key: quality

description: Modifies the entry's weight based on the killing/opening/fishing player's luck attribute. Formula is floor( weight + (quality * generic.luck)).


description: Schema for lists of tokens compatible with the Uniswap Interface

required: major minor patch

examples: compound stablecoin

examples: color is_fee_on_transfer aliases

required: name description

examples: stablecoin compound

required: chainId address decimals name symbol

format: date-time

Uniswap

symbol: UNI

examples:
compound
lending
personal tokens

required: name timestamp version tokens


key: Version

description: The version of the list, used in change detection


key: major

description: The major version of the list. Must be incremented when tokens are removed from the list or token addresses are changed.


key: minor

description: The minor version of the list. Must be incremented when tokens are added to the list.


key: patch

description: The patch version of the list. Must be incremented for any changes to the list.


key: TagIdentifier

description: The unique identifier of a tag


key: ExtensionIdentifier

description: The name of a token extension property


key: ExtensionMap

description: An object containing any arbitrary or vendor-specific token metadata


key: TagDefinition

description: Definition of a tag that can be associated with a token via its identifier


key: name

description: The name of the tag


key: description

description: A user-friendly description of the tag


key: examples

description: A token with value pegged to another asset


key: TokenInfo

description: Metadata for a single token in a token list


key: chainId

description: The chain ID of the Ethereum network where this token is deployed


key: address

description: The checksummed address of the token on the specified chain ID


key: decimals

description: The number of decimals for the token balance


description: The name of the token


key: symbol

description: The symbol for the token


key: logoURI

description: A URI to the token logo asset; if not set, interface will attempt to find a logo based on the token address; suggest SVG or PNG of size 64x64


key: tags

description: An array of tag identifiers associated with the token; tags are defined at the list level


description: The name of the token list


key: timestamp

description: The timestamp of this list version; i.e. when this immutable version of the list was created


key: tokens

description: The list of tokens included in the list


key: tokenMap

description: A mapping of key 'chainId_tokenAddress' to its corresponding token object


key: keywords

description: Keywords associated with the contents of the list; may be used in list discoverability


key: items

description: A keyword to describe the contents of the list


description: A mapping of tag identifiers to their name and description


key: stablecoin


description: A URI for the logo of the token list; prefer SVG or PNG of size 256x256


key: lightbox

description: Settings related to the lightbox behavior.

enum: fade zoom


key: enabled

description: Allow users to enable the lightbox behavior.


key: animation

description: Set lightbox animation. Possible values: `fade`, `zoom`, `''` (empty string).


key: ref

description: A reference to another property value. e.g. `styles.color.text`


key: appearanceTools

description:
Setting that enables the following UI tools:

- border: color, radius, style, width
- color: link
- dimensions: minHeight
- position: sticky
- spacing: blockGap, margin, padding
- typography: lineHeight


key: useRootPaddingAwareAlignments

description:
_**Note:** Since WordPress 6.1._

Enables root padding (the values from `styles.spacing.padding`) to be applied to the contents of full-width blocks instead of the root block.

Please note that when using this setting, `styles.spacing.padding` should always be set as an object with `top`, `right`, `bottom`, `left` values declared separately.


key: border

description: Settings related to borders.


key: color

description: Allow users to set custom border colors.


key: radius

description: Allow users to set custom border radius.


key: style

description: Allow users to set custom border styles.


key: width

description: Allow users to set custom border widths.


key: shadow

description: Settings related to shadows.

required: name slug shadow


key: defaultPresets

description: Allow users to choose shadows from the default shadow presets.


key: presets

description:
Shadow presets for the shadow picker.
Generates a single custom property (`--wp--preset--shadow--{slug}`) per preset value.


key: name

description: Name of the shadow preset, translatable.


key: slug

description: Kebab-case unique identifier for the shadow preset.


description: CSS box-shadow value


description: Settings related to colors.

required: name slug colors

required: name slug gradient

required: name slug color


key: background

description: Allow users to set background colors.


key: custom

description: Allow users to select custom colors.


key: customDuotone

description: Allow users to create custom duotone filters.


key: customGradient

description: Allow users to create custom gradients.


key: defaultDuotone

description: Allow users to choose filters from the default duotone filter presets.


key: defaultGradients

description: Allow users to choose colors from the default gradients.


key: defaultPalette

description: Allow users to choose colors from the default palette.


key: duotone

description:
Duotone presets for the duotone picker.
Doesn't generate classes or properties.


description: Name of the duotone preset, translatable.


description: Kebab-case unique identifier for the duotone preset.


key: colors

description: List of colors from dark to light.


key: items

description: CSS hex or rgb string.


key: gradients

description:
Gradient presets for the gradient picker.
Generates a single class (`.has-{slug}-background`) and custom property (`--wp--preset--gradient--{slug}`) per preset value.


description: Name of the gradient preset, translatable.


description: Kebab-case unique identifier for the gradient preset.


key: gradient

description: CSS gradient string.


key: link

description: Allow users to set link colors.


key: palette

description:
Color palette presets for the color picker.
Generates three classes (`.has-{slug}-color`, `.has-{slug}-background-color`, and `.has-{slug}-border-color`) and a single custom property (`--wp--preset--color--{slug}`) per preset value.


description: Name of the color preset, translatable.


description: Kebab-case unique identifier for the color preset.


key: color

description: CSS hex or rgb(a) string.


key: text

description: Allow users to set text colors.


key: dimensions

description: Settings related to dimensions.


key: minHeight

description: Allow users to set custom minimum height.


key: layout

description: Settings related to layout.


key: contentSize

description: Sets the max-width of the content.


key: wideSize

description: Sets the max-width of wide (`.alignwide`) content. Also used as the maximum viewport when calculating fluid font sizes


key: allowEditing

description: Disable the layout UI controls.


key: position

description: Settings related to position.


key: sticky

description: Allow users to set sticky position.


key: spacing

description: Settings related to spacing.

default: px em rem vh vw %

enum: px em rem vh vw %

default: rem