key: labelAngle

description:
The rotation angle of the axis labels.

__Default value:__ `-90` for nominal and ordinal fields; `0` otherwise.


key: labelBound

description:
Indicates if labels should be hidden if they exceed the axis range. If `false `(the default) no bounds overlap analysis is performed. If `true`, labels will be hidden if they exceed the axis range by more than 1 pixel. If this property is a number, it specifies the pixel tolerance: the maximum amount by which a label bounding box may exceed the axis range.

__Default value:__ `false`.

type: boolean number


key: labelFlush

description:
Indicates if the first and last axis labels should be aligned flush with the scale range. Flush alignment for a horizontal axis will left-align the first label and right-align the last label. For vertical axes, bottom and top text baselines are applied instead. If this property is a number, it also indicates the number of pixels by which to offset the first and last labels; for example, a value of 2 will flush-align the first and last labels and also push them 2 pixels outward from the center of the axis. The additional adjustment can sometimes help the labels better visually group with corresponding axis ticks.

__Default value:__ `true` for axis of a continuous x-scale. Otherwise, `false`.


key: labelOverlap

description:
The strategy to use for resolving overlap of axis labels. If `false` (the default), no overlap reduction is attempted. If set to `true` or `"parity"`, a strategy of removing every other label is used (this works well for standard linear axes). If set to `"greedy"`, a linear scan of the labels is performed, removing any labels that overlaps with the last visible label (this often works better for log-scaled axes).

__Default value:__ `true` for non-nominal fields with non-log scales; `"greedy"` for log scales; otherwise `false`.

type: boolean

type: string


key: labelPadding

description: The padding, in pixels, between axis and text labels.

type: number


key: labels

description:
A boolean flag indicating if labels should be included as part of the axis.

__Default value:__  `true`.


key: maxExtent

description:
The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

__Default value:__ `undefined`.


key: minExtent

description:
The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

__Default value:__ `30` for y-axis; `undefined` for x-axis.


key: tickSize

description: The size in pixels of axis ticks.


key: ticks

description: Boolean value that determines whether the axis should include ticks.


key: titleMaxLength

description: Max length for axis title if the title is automatically generated from the field's description.


key: titlePadding

description: The padding, in pixels, between title and axis.


key: bandPosition

description: An interpolation fraction indicating where, for `band` scales, axis ticks should be positioned. A value of `0` places ticks at the left edge of their bands. A value of `0.5` places ticks in the middle of their bands.


key: domain

description:
A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

__Default value:__ `true`


key: domainColor

description:
Color of axis domain line.

__Default value:__  (none, using Vega default).


key: domainWidth

description:
Stroke width of axis domain line

__Default value:__  (none, using Vega default).


key: grid

description:
A boolean flag indicating if grid lines should be included as part of the axis

__Default value:__ `true` for [continuous scales](scale.html#continuous) that are not binned; otherwise, `false`.


key: gridColor

description: Color of gridlines.


key: gridDash

description: The offset (in pixels) into which to begin drawing with the grid dash array.

type: array


key: gridOpacity

description:
The stroke opacity of grid (value between [0,1])

__Default value:__ (`1` by default)


key: gridWidth

description: The grid width, in pixels.


key: labelAngle

description:
The rotation angle of the axis labels.

__Default value:__ `-90` for nominal and ordinal fields; `0` otherwise.


key: labelBound

description:
Indicates if labels should be hidden if they exceed the axis range. If `false `(the default) no bounds overlap analysis is performed. If `true`, labels will be hidden if they exceed the axis range by more than 1 pixel. If this property is a number, it specifies the pixel tolerance: the maximum amount by which a label bounding box may exceed the axis range.

__Default value:__ `false`.


key: labelColor

description: The color of the tick label, can be in hex color code or regular color name.


key: labelFlush

description:
Indicates if the first and last axis labels should be aligned flush with the scale range. Flush alignment for a horizontal axis will left-align the first label and right-align the last label. For vertical axes, bottom and top text baselines are applied instead. If this property is a number, it also indicates the number of pixels by which to offset the first and last labels; for example, a value of 2 will flush-align the first and last labels and also push them 2 pixels outward from the center of the axis. The additional adjustment can sometimes help the labels better visually group with corresponding axis ticks.

__Default value:__ `true` for axis of a continuous x-scale. Otherwise, `false`.


key: labelFont

description: The font of the tick label.


key: labelFontSize

description: The font size of the label, in pixels.


key: labelLimit

description: Maximum allowed pixel width of axis tick labels.


key: labelOverlap

description:
The strategy to use for resolving overlap of axis labels. If `false` (the default), no overlap reduction is attempted. If set to `true` or `"parity"`, a strategy of removing every other label is used (this works well for standard linear axes). If set to `"greedy"`, a linear scan of the labels is performed, removing any labels that overlaps with the last visible label (this often works better for log-scaled axes).

__Default value:__ `true` for non-nominal fields with non-log scales; `"greedy"` for log scales; otherwise `false`.


key: labelPadding

description: The padding, in pixels, between axis and text labels.


key: labels

description:
A boolean flag indicating if labels should be included as part of the axis.

__Default value:__  `true`.


key: maxExtent

description:
The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

__Default value:__ `undefined`.


key: minExtent

description:
The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

__Default value:__ `30` for y-axis; `undefined` for x-axis.


key: tickColor

description: The color of the axis's tick.


key: tickRound

description: Boolean flag indicating if pixel position values should be rounded to the nearest integer.


key: tickSize

description: The size in pixels of axis ticks.


key: tickWidth

description: The width, in pixels, of ticks.


key: ticks

description: Boolean value that determines whether the axis should include ticks.


key: titleAlign

description: Horizontal text alignment of axis titles.


key: titleAngle

description: Angle in degrees of axis titles.


key: titleBaseline

description: Vertical text baseline for axis titles.


key: titleColor

description: Color of the title, can be in hex color code or regular color name.


key: titleFont

description: Font of the title. (e.g., `"Helvetica Neue"`).


key: titleFontSize

description: Font size of the title.


key: titleFontWeight

description: Font weight of the title. (e.g., `"bold"`).

type: string number


key: titleLimit

description: Maximum allowed pixel width of axis titles.


key: titleMaxLength

description: Max length for axis title if the title is automatically generated from the field's description.


key: titlePadding

description: The padding, in pixels, between title and axis.


key: titleX

description: X-coordinate of the axis title relative to the axis group.


key: titleY

description: Y-coordinate of the axis title relative to the axis group.


key: entryPadding

description: Padding (in pixels) between legend entries in a symbol legend.


key: offset

description:
The offset, in pixels, by which to displace the legend from the edge of the enclosing group or data rectangle.

__Default value:__  `0`


key: orient

description:
The orientation of the legend, which determines how the legend is positioned within the scene. One of "left", "right", "top-left", "top-right", "bottom-left", "bottom-right", "none".

__Default value:__ `"right"`


key: padding

description: The padding, in pixels, between the legend and axis.


key: cornerRadius

description: Corner radius for the full legend.


key: fillColor

description: Background fill color for the full legend.


key: gradientHeight

description: The height of the gradient, in pixels.


key: gradientLabelBaseline

description: Text baseline for color ramp gradient labels.


key: gradientLabelLimit

description: The maximum allowed length in pixels of color ramp gradient labels.


key: gradientLabelOffset

description: Vertical offset in pixels for color ramp gradient labels.


key: gradientStrokeColor

description: The color of the gradient stroke, can be in hex color code or regular color name.


key: gradientStrokeWidth

description: The width of the gradient stroke, in pixels.


key: gradientWidth

description: The width of the gradient, in pixels.


key: labelAlign

description: The alignment of the legend label, can be left, middle or right.


key: labelBaseline

description: The position of the baseline of legend label, can be top, middle or bottom.


key: labelColor

description: The color of the legend label, can be in hex color code or regular color name.


key: labelFont

description: The font of the legend label.


key: labelFontSize

description:
The font size of legend label.

__Default value:__ `10`.


key: labelLimit

description: Maximum allowed pixel width of axis tick labels.


key: labelOffset

description: The offset of the legend label.


key: offset


key: orient


key: padding


key: strokeColor

description: Border stroke color for the full legend.


key: strokeDash

description: Border stroke dash pattern for the full legend.


key: strokeWidth

description: Border stroke width for the full legend.


key: symbolColor

description: The color of the legend symbol,


key: symbolSize

description: The size of the legend symbol, in pixels.


key: symbolStrokeWidth

description: The width of the symbol's stroke.


key: symbolType

description: Default shape type (such as "circle") for legend symbols.


key: titleAlign

description: Horizontal text alignment for legend titles.


key: titleBaseline

description: Vertical text baseline for legend titles.


key: titleColor

description: The color of the legend title, can be in hex color code or regular color name.


key: titleFont

description: The font of the legend title.


key: titleFontSize

description: The font size of the legend title.


key: titleFontWeight

description: The font weight of the legend title.


key: titleLimit

description: Maximum allowed pixel width of axis titles.


key: titlePadding

description: The padding, in pixels, between title and legend.


key: align

description: The horizontal alignment of the text. One of `"left"`, `"right"`, `"center"`.


key: angle

description: The rotation angle of the text, in degrees.


key: baseline

description:
The vertical alignment of the text. One of `"top"`, `"middle"`, `"bottom"`.

__Default value:__ `"middle"`


key: dx

description: The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.


key: dy

description: The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.


key: fill

description:
Default Fill Color.  This has higher precedence than config.color

__Default value:__ (None)


key: fillOpacity

description:
The fill opacity (value between [0,1]).

__Default value:__ `1`


key: font

description: The typeface to set the text in (e.g., `"Helvetica Neue"`).


key: fontSize

description: The font size, in pixels.


key: fontStyle

description: The font style (e.g., `"italic"`).


key: fontWeight

description: The font weight (e.g., `"bold"`).


key: interpolate

description:
The line interpolation method to use for line and area marks. One of the following:
- `"linear"`: piecewise linear segments, as in a polyline.
- `"linear-closed"`: close the linear segments to form a polygon.
- `"step"`: alternate between horizontal and vertical segments, as in a step function.
- `"step-before"`: alternate between vertical and horizontal segments, as in a step function.
- `"step-after"`: alternate between horizontal and vertical segments, as in a step function.
- `"basis"`: a B-spline, with control point duplication on the ends.
- `"basis-open"`: an open B-spline; may not intersect the start or end.
- `"basis-closed"`: a closed B-spline, as in a loop.
- `"cardinal"`: a Cardinal spline, with control point duplication on the ends.
- `"cardinal-open"`: an open Cardinal spline; may not intersect the start or end, but will intersect other control points.
- `"cardinal-closed"`: a closed Cardinal spline, as in a loop.
- `"bundle"`: equivalent to basis, except the tension parameter is used to straighten the spline.
- `"monotone"`: cubic interpolation that preserves monotonicity in y.


key: limit

description: The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.


key: opacity

description:
The overall opacity (value between [0,1]).

__Default value:__ `0.7` for non-aggregate plots with `point`, `tick`, `circle`, or `square` marks or layered `bar` charts and `1` otherwise.


key: orient

description:
The orientation of a non-stacked bar, tick, area, and line charts.
The value is either horizontal (default) or vertical.
- For bar, rule and tick, this determines whether the size of the bar and tick
should be applied to x or y dimension.
- For area, this property determines the orient property of the Vega output.
- For line, this property determines the sort order of the points in the line
if `config.sortLineBy` is not specified.
For stacked charts, this is always determined by the orientation of the stack;
therefore explicitly specified value will be ignored.


key: radius

description: Polar coordinate radial offset, in pixels, of the text label from the origin determined by the `x` and `y` properties.


key: shape

description:
The default symbol shape to use. One of: `"circle"` (default), `"square"`, `"cross"`, `"diamond"`, `"triangle-up"`, or `"triangle-down"`, or a custom SVG path.

__Default value:__ `"circle"`


key: size

description:
The pixel area each the point/circle/square.
For example: in the case of circles, the radius is determined in part by the square root of the size value.

__Default value:__ `30`


key: stroke

description:
Default Stroke Color.  This has higher precedence than config.color

__Default value:__ (None)


key: strokeDash

description: An array of alternating stroke, space lengths for creating dashed or dotted lines.


key: strokeDashOffset

description: The offset (in pixels) into which to begin drawing with the stroke dash array.


key: strokeOpacity

description:
The stroke opacity (value between [0,1]).

__Default value:__ `1`


key: strokeWidth

description: The stroke width, in pixels.


key: tension

description: Depending on the interpolation type, sets the tension parameter (for line and area marks).


key: text

description: Placeholder text if the `text` channel is not specified


key: theta

description: Polar coordinate angle, in radians, of the text label from the origin determined by the `x` and `y` properties. Values for `theta` follow the same convention of `arc` mark `startAngle` and `endAngle` properties: angles are measured in radians, with `0` indicating "north".


key: anchor

description:
The anchor position for placing the title. One of `"start"`, `"middle"`, or `"end"`. For example, with an orientation of top these anchor positions map to a left-, center-, or right-aligned title.

__Default value:__ `"middle"` for [single](spec.html) and [layered](layer.html) views.
`"start"` for other composite views.

__Note:__ [For now](https://github.com/vega/vega-lite/issues/2875), `anchor` is only customizable only for [single](spec.html) and [layered](layer.html) views.  For other composite views, `anchor` is always `"start"`.


key: angle

description: Angle in degrees of title text.


key: baseline

description: Vertical text baseline for title text.


key: color

description: Text color for title text.


key: font

description: Font name for title text.


key: fontSize

description:
Font size in pixels for title text.

__Default value:__ `10`.


key: fontWeight

description: Font weight for title text.


key: limit

description: The maximum allowed length in pixels of legend labels.


key: offset

description: Offset in pixels of the title from the chart body and axes.


key: orient

description: Default title orientation ("top", "bottom", "left", or "right")


key: clip

description: Whether the view should be clipped.


key: fill

description:
The fill color.

__Default value:__ (none)


key: fillOpacity

description:
The fill opacity (value between [0,1]).

__Default value:__ (none)


key: height

description:
The default height of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) y-scale with `rangeStep` = `null`.

__Default value:__ `200`


key: stroke

description:
The stroke color.

__Default value:__ (none)


key: strokeDash

description:
An array of alternating stroke, space lengths for creating dashed or dotted lines.

__Default value:__ (none)


key: strokeDashOffset

description:
The offset (in pixels) into which to begin drawing with the stroke dash array.

__Default value:__ (none)


key: strokeOpacity

description:
The stroke opacity (value between [0,1]).

__Default value:__ (none)


key: strokeWidth

description:
The stroke width, in pixels.

__Default value:__ (none)


key: width

description:
The default width of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) x-scale or ordinal x-scale with `rangeStep` = `null`.

__Default value:__ `200`


key: shortTimeLabels

description:
Whether month names and weekday names should be abbreviated.

__Default value:__  `false`


key: ^type

description: 5 types: Base Type, Composite, Enum, Domain, Range

type: object

type: integer


description: Schema for the generation file of fulibWorkflows


key: workflowItem

description: The title of your current workflow


key: externalSystemItem

description: Can be used to address data coming from another source


key: serviceItem

description: The service on which the following events are executed


key: commandItem

description: A command send by a user


key: eventItem

description: An event signalling that some system state is reached


key: policyItem

description: The following steps define the reaction of a service to some triggering command or event


key: userItem

description: Defines the user who is going to perform an action


key: dataItem

description: data object created within a service


key: pageItem

description: Defines a ui page


key: problemItem

description: Shows a problem/question in the workflow


key: divItem

description: Defines a ui page


description: Haystack Pipeline YAML file describing the nodes of the pipelines. For more info read the docs at: https://haystack.deepset.ai/components/pipelines#yaml-file-definitions

const: ignore


description: Indent size. [JS,CSS,HTML]


description: Indentation character. [JS,CSS,HTML]


key: eol

description: Character(s) to use as line terminators. [JS,CSS,HTML]


description: Indent with tabs, overrides 'indent_size' and 'indent_char' [JS,CSS,HTML]


description: Ensure newline at end of file. [JS,CSS,HTML]


description: Preserve line-breaks. [JS,CSS,HTML]


description: Number of line-breaks to be preserved in one chunk. [JS,HTML]


description: [collapse|expand|end-expand|none][,preserve-inline]  [JS,HTML]

default: collapse

enum: collapse expand end-expand none collapse,preserve-inline expand,preserve-inline end-expand,preserve-inline none,preserve-inline


description: Wrap lines at next opportunity after N characters. [JS,HTML]


description: Add a newline between multiple selectors. [CSS]


description: Add a newline between CSS rules. [CSS]


description: (Deprecated: use space_around_combinator) [CSS]


description: Ensure space around selector separators (>+~). [CSS]


description: HTLM void elements - aka self-closing tags. [HTML]

default: area base br col embed hr img input keygen link menuitem meta param source track wbr !doctype ?xml ?php basefont isindex


description: Wrap attributes to new lines. [HTML]

default: auto

enum: auto force force-aligned force-expand-multiline


description: Indent wrapped attributes to after N characters. Defaults to 'indent_size'. [HTML]


description: Indent <head> and <body> sections. [HTML]


description: [keep|separate|normal] [HTML]

default: normal

enum: keep separate normal


key: unformatted

description: List of tags that should not be reformatted. [HTML]

default: a abbr area audio b bdi bdo br button canvas cite code data datalist del dfn em embed i iframe img input ins kbd keygen label map mark math meter noscript object output progress q ruby s samp select small span strong sub sup svg template textarea time u var video wbr text acronym address big dt ins strike tt


description: List of tags whose content should not be reformatted. [HTML]


description: List of tags that should have an extra newline before them. [HTML]

default: head body /html


description: Indent elements within html <body> element. [HTML]


description: Indent elements within html <head> element. [HTML]


description: format and indent {{#foo}} and {{/foo}}. [HTML]


description: Initial indentation level. [JS]


description: Add padding spaces within parentheses, ie. f( a, b ). [JS]


description: Leave space in empty parentheses, ie. f( ). [JS]


description: Enable jslint-stricter mode. (Forces 'space_after_anon_function') [JS]


description: Add a space before an anonymous function's parens, ie. function (). [JS]


description: Break chained method calls across subsequent lines. [JS]


description: Preserve array indentation. [JS]


description: Preserve function indentation. [JS]


description: Ensure a space before conditional statement. [JS]


description: Decode printable characters encoded in xNN notation. [JS]


description: Put commas at the beginning of new line instead of end. [JS]


description: Move operators to before or after a new line, or keep as is. [JS]

default: before-newline


description: Pass E4X xml literals through untouched. [JS]


description: Unindent chained methods. [JS]


description: Configuration for Crowdin, a crowd-translation platform.

format: uri


description: Replace the default commit message with the one specified in commit_message.


description: Specify a list of specific languages to export.


description: Defines whether to translate texts placed inside the tags.


description: Defines whether to translate tags' attributes.


description: Defines whether to split long texts into smaller text segments.


description: An array of strings, where each item is the XPaths to DOM element that should be imported.


description: Defines whether a single quote should be escaped by another single quote or backslash in exported translations.


description: Defines whether any special characters (=, :, ! and #) should be escaped by backslash in exported translations.


key: file

description: This object or string represents the file format


key: fileFormat

description: This object represents a file format


key: name

description: Name of block file


key: template

description: Path to file template


key: blocks

description: An array of your app's blocks.

required: type path


key: type

description: The name of the block type


key: path

description: Path relative to root where the block will be stored


key: isFile

description: Is this a file? or a folder? False by default.


key: files

description: Files making up the block


key: fileFormats

description: An object mapping file objects to strings


key: target

description: Restrict this dependency to matching only a Project or a Package

enum: project package


key: script

description:
A command line script or scripts.

Available variables:
%project:Directory% - The project directory
%project:Name% - The project name
%project:Version% - The project version

type: string array


key: packInclude

description: Pairs of destination folders and glob patterns specifying additional files to include in the output NuGet package. (data type: JSON map). Example: { "tools/": "tools/**/*.*" }


key: publishExclude

description: Glob pattern to specify files to exclude from publish output. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]


key: compile

description: Glob pattern to specify files to compile. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]


key: compileExclude

description: Glob pattern to specify files to exclude from compilation. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]


key: compileFiles

description: Files to include in compilation (overrides 'compileExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]


key: content

description: Glob pattern to specify files to include as content. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]


key: contentExclude

description: Glob pattern to specify files to exclude from the content list. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]


key: contentFiles

description: Files to include as content (overrides 'contentExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]


key: preprocess

description: Glob pattern to specify files to use for preprocessing. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]


key: preprocessExclude

description: Glob pattern to specify files to exclude from use for preprocessing. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]


key: preprocessFiles

description: Files to include to use for preprocessing (overrides 'preprocessExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]


key: resource

description: Glob pattern to specify files to include as resources. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]


key: resourceExclude

description: Glob pattern to specify files to exclude from the resources list. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]


key: resourceFiles

description: Files to include as resources (overrides 'resourceExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]


key: shared

description: Glob pattern to specify files to share with dependent projects. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]


key: sharedExclude

description: Glob pattern to specify files to exclude from sharing with dependent projects. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]


key: sharedFiles

description: Files to include for sharing with dependent projects (overrides 'sharedExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]


key: exclude

description: Glob pattern to indicate files to exclude from other glob patterns, in addition to the default patterns specified in 'excludeBuiltIn'. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]


key: excludeBuiltIn

description: Default glob pattern to indicate files to exclude from other glob patterns. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

default: bin/** obj/** **/*.xproj


key: configurations

description: Configurations are named groups of compilation settings. There are two defaults built into the runtime: 'Debug' and 'Release'.


key: copyright

description: Copyright details for the package.


key: iconUrl

description: A URL for the image to use as the icon for the package. This should be a 32x32-pixel .png file that has a transparent background.


key: licenseUrl

description: A link to the license for the package.


key: requireLicenseAcceptance

description: A Boolean value that specifies whether the client needs to ensure that the package license (described by licenseUrl) is accepted before the package is installed.


key: projectUrl

description: A URL for the home page of the package.


key: summary

description: A short description of the package.


key: tags

description: A space-delimited list of tags and keywords that describe the package.


key: title

description: The human-friendly title of the package


key: releaseNotes

description: A description of the changes made in each release of the package.


key: language

description: The locale ID for the package, such as en-us.


key: description

description: The description of the project/package.


key: namedResource

description: Overrides the generated resource names with custom ones.


key: repository

description: Contains information about the repository where the project is stored.

default: git


key: scripts

description: Scripts to execute during the various stages.


key: version

description: The version of the project/package. Examples: 1.2.3, 1.2.3-beta, 1.2.3-*


description: The dot-separated path to the mixin class relative to the specified package. The class must be annotated with @Mixin


description: Injection options

default: default


key: defaultRequire

description: Sets the default minimum of injections that must be successfully applied per injector


key: defaultGroup

description: Sets the default injector group


key: injectionPoints

description: Registers injection points for this configuration


key: maxShiftBy

description: Sets the maximum allowed number of opcodes that can be shifted in @At annotations. This is hard capped at 5


description: Overwrite options


key: conformVisibility

description: Sets whether the visibility of overwritten methods should be conformed to the target class


key: requireAnnotations

description: Sets whether overwriting methods must explicitly be declared through @Overwrite annotations


key: parent

description: The name of a parent configuration that options get inherited from


key: target

description: Target selector. Either the specifies the phase directly or use "@env(PHASE)" separated by '&', '\', or ' '


key: minVersion

description: Minimum version of the mixin subsystem required for this configuration


key: compatibilityLevel

description: Minimum compatibility level required for mixins in this set


key: required

description: Determines whether mixin failures in this configuration are considered terminal and stop the game


key: priority

description: The priority of this configuration. Will be inherited if smaller than 0


key: mixinPriority

description: Default mixin priority for this configuration. Will be inherited if smaller than 0


key: package

description: The target package where the mixin classes reside


key: mixins

description: Mixin classes to load in all environments. Class names get prepended with the specified package


key: client

description: Mixin classes to load ONLY on client. Class names get prepended with the specified package


key: server

description: Mixin classes to load ONLY on server. Class names get prepended with the specified package


key: setSourceFile

description: Sets whether targets' source files will be updated to the mixin source file


key: refmap

description: The path to the reference map resource to use for this configuration


key: verbose

description: Increases log detail level from DEBUG to INFO


key: plugin

description: Name of the mixin config plugin to use for this config


key: bitwise

description: Prohibit the use of bitwise operators (&, |, ^, etc.)


key: curly

description: Requires you to always put curly braces around blocks in loops and conditionals


key: eqeqeq

description: Prohibits the use of `==` and `!=` in favor of `===` and `!==`


key: esversion

description: The ECMAScript version to which the code must adhere


key: forin

description: Requires all `for in` loops to filter object's items with obj.hasOwnProperty()


key: freeze

description: Prohibits overwriting prototypes of native objects such as Array, Date and so on


key: funcscope

description: Suppresses warnings about declaring variables inside of control structures while accessing them later from the outside


key: futurehostile

description: Enables warnings about the use of identifiers which are defined in future versions of JavaScript


key: iterator

description: Suppresses warnings about the __iterator__ property.


key: latedef

description: Prohibits the use of a variable before it was defined


key: leanswitch

description: Prohibits unnecessary clauses within `switch` statements


key: maxcomplexity

description: Max cyclomatic complexity per function

type: boolean integer


key: maxdepth

description: Max depth of nested blocks


key: maxerr

description: Maximum amount of warnings JSHint will produce before giving up


key: maxparams

description: Max number of formal parameters allowed per function


key: maxstatements

description: Max number statements per function


key: noarg

description: Prohibits the use of `arguments.caller` and `arguments.callee`


key: nocomma

description: Prohibits the use of the comma operator


key: nonbsp

description: Warns about `non-breaking whitespace` characters


key: nonew

description: Prohibits the use of constructors for side-effects (without assignment)


key: notypeof

description: Suppresses warnings about invalid `typeof`operator values


key: noreturnawait

description: Async functions resolve on their return value. In most cases, this makes returning the result of an AwaitExpression (which is itself a Promise instance) unnecessary


key: regexpu

description: Enables warnings for regular expressions which do not include the 'u' flag


key: shadow

description: Suppresses warnings about variable shadowing. i.e. declaring a variable that had been already declared somewhere in the outer scope

type: boolean string


key: singleGroups

description: Prohibits the use of the grouping operator when it is not strictly required.


key: strict

description: Requires all code to run in ES5 strict mode


key: trailingcomma

description: Warns when a comma is not placed after the last element in an array or object literal


key: undef

description: Prohibits the use of explicitly undeclared variables


key: unused

description: Warns when you define and never use your variables


key: varstmt

description: Forbids the use of VariableStatements (`var`) in favor of `let` and `const`


key: asi

description: Suppresses warnings about missing semicolons


key: boss

description: Suppresses warnings about the use of assignments in cases where comparisons are expected


key: debug

description: Suppresses warnings about the `debugger` statements in your code


key: elision

description: Tells JSHint that your code uses ES3 array elision elements, or empty elements


key: eqnull

description: Suppresses warnings about `== null` comparisons


key: evil

description: Suppresses warnings about the use of `eval`


key: expr

description: Suppresses warnings about the use of expressions where normally you would expect to see assignments or function calls


key: lastsemic

description: Suppresses warnings about missing semicolons, but only when the semicolon is omitted for the last statement in a one-line block


key: loopfunc

description: Suppresses warnings about functions inside of loops


key: moz

description: Tells JSHint that your code uses Mozilla JavaScript extensions


key: noyield

description: Suppresses warnings about generator functions with no `yield` statement in them


key: plusplus

description: Prohibits the use of `++` and `--`


key: proto

description: Suppresses warnings about the `__proto__` property


key: scripturl

description: Suppresses warnings about the use of script-targeted URLs


key: supernew

description: Suppresses warnings about constructions like `new function () { ... };` and `new Object;`


key: validthis

description: Suppresses warnings about possible strict violations when the code is running in strict mode and you use `this` in a non-constructor function


key: withstmt

description: Suppresses warnings about the use of the `with` statement


key: browser

description: [Environment] Web Browser (window, document, etc)


key: browserify

description: [Environment] Browserify


key: couch

description: [Environment] CouchDB


key: devel

description: [Environment] Development/debugging (alert, confirm, etc)


key: dojo

description: [Environment] Dojo Toolkit


key: jasmine

description: [Environment] Jasmine unit testing framework


key: jquery

description: [Environment] jQuery


key: mocha

description: [Environment] Mocha unit testing framework


key: module

description: [Environment] ES6 module


key: mootools

description: [Environment] MooTools


key: node

description: [Environment] Node.js


key: nonstandard

description: [Environment] Widely adopted globals (escape, unescape, etc)


key: phantom

description: [Environment] PhantomJS runtime environment


key: prototypejs

description: [Environment] Prototype JavaScript framework


key: rhino

description: [Environment] Rhino


key: shelljs

description: [Environment] Defines globals exposed by the ShellJS library


key: typed

description: [Environment] Defines globals for typed array constructors


key: worker

description: [Environment] Web Workers


key: wsh

description: [Environment] Windows Scripting Host


key: yui

description: [Environment] Yahoo User Interface


key: globals

description: Specify a white list of global variables that are not formally defined in the source code


key: additionalProperties

description: Name of the global. Set to `true` for read/write, `false` for read-only.


key: extends

description: Specify the path to another configuration file to use as a base, relative to the current file


key: overrides

description: Specify the options that should only be applied to files matching a given path pattern


description: The path pattern to apply the given options to


key: include

description: Include other properties files as global variables, accessible in any stage. The key value pairs in the included file are imported with a prefix appended; the prefix is specified here as the key.


key: globalVariables

description: Variables which can be accessed in any stage. Variables can be used in the definition of other variables, and may be defined in any order.


key: endStage

description: This stage runs after all of the stages in the stages block. The end stage is guaranteed to execute. If there is an exception in any stage, the end stage will still execute.


key: stageVariables

description: Variables which can be accessed only in this stage. Variables can be used in the definition of other variables, and may be defined in any order.


key: actions

description: The actions to run in this stage.


key: if

description: Conditional control of whether the stage is executed or skipped


key: type

description: Specify the type of the action. If omitted or left empty, it is assumed that the type is 'liquibase'.


key: adapter

description: The language adapter to use


key: value

description: The entrypoint function or class


key: entrypoint

description: The entrypoint function or class


key: email

description: Contact e-mail pertaining to the mod


key: irc

description: IRC channel pertaining to the mod. Must be of a valid URL format


key: homepage

description: Project or user homepage. Must be a valid HTTP/HTTPS address


key: issues

description: Project issue tracker. Must be a valid HTTP/HTTPS address


key: sources

description: Project source code repository. Must be a valid URL


key: additionalProperties

description: Custom contact or profile informations


key: environment

description: The environment where this mod will be loaded

enum: * client server


key: file

description: A string value pointing to a path from the root of the JAR to a nested JAR which should be loaded alongside the outer mod JAR


key: person

description: The name of the person


key: name

description: The name of the person


key: contact

description: Contact information for the person


key: versionRanges

description: Multiple version ranges that are combined with an "OR" relationship - only one of the ranges needs to match


key: versionRange

description:
A version range that matches versions. The following variants are supported:

- A single asterisk matches any version.
- Ranges following NPM semver specification including >=, >, =, <, <=, X-ranges (1.x), tilde ranges (fixed minor) and caret ranges (fixed major).
- Additionally exact string matches will always be performed.

x-intellij-html-description:
A version range or an array of those that match versions. The following variants are supported:

* matches any version.

Ranges following NPM semver specification:

>=, >, =, < and <

X-ranges to specify variable components, e.g. 1.x

tilde ranges that allow patch version changes, e.g. ~1.2.3

caret ranges that allow up to minor version changes, e.g. ^1.2.3

Exact string matches are always performed as well.

If an array of ranges is used, they're treated as in an "OR" relationship - only one of the ranges needs to match.


key: id

description: The mod identifier


key: version

description: The mod version


key: schemaVersion

description: The version of the fabric.mod.json schema


key: entrypoints

description: The entrypoints used by this mod


key: main

description: The entrypoint for all environments (classes must implement ModInitializer)


key: client

description: The entrypoint for the client environment (classes must implement ClientModInitializer)


key: server

description: The entrypoint for the server environment (classes must implement DedicatedServerModInitializer)


key: preLaunch

description: The entrypoint called just before the game instance is created (classes must implement PreLaunchEntrypoint)


key: fabric-datagen

description: The entrypoint for the data generator environment (classes must implement DataGeneratorEntrypoint)


key: fabric-gametest

description: The entrypoint for the Game Test environment (classes must implement FabricGameTest)


key: additionalProperties

description: Custom mod entrypoints


key: jars

description: Contains an array of nestedJar objects


key: languageAdapters

description: A string→string dictionary, connecting namespaces to LanguageAdapter implementations


key: items

description: Path to mixin file from the root of the JAR


key: config


key: accessWidener

description: Path to an access widener definition file


key: depends

description: id→versionRange map for dependencies. Failure to meet these causes a hard failure


key: recommends

description: id→versionRange map for dependencies. Failure to meet these causes a soft failure (warning)


key: suggests

description: id→versionRange map for dependencies. Are not matched and are mainly used as metadata


key: conflicts

description: id→versionRange map for dependencies. A successful match causes a soft failure (warning)


key: breaks

description: id→versionRange map for dependencies. A successful match causes a hard failure


key: name

description: Name of the mod


key: description

description: Description of the mod


key: authors

description: The direct authorship information


key: contributors

description: Contributors to this mod


key: contact

description: Contact information for the mod


key: license

description: The license the mod uses


key: icon

description: The path to a single .PNG file from the root of the JAR


description: A string→string dictionary, where the keys conform to widths of each PNG file, and the values are said files' paths


key: additionalProperties


key: custom

description: A map of namespace:id→value for custom data fields.


key: output

description: license report output format

default: json

enum: json table csv html


key: html

description: HTML output format


key: tableify

description: passed directly to tableify (see: https://github.com/kessler/node-tableify)


key: delimiter

description: CSV output format


key: escapeCsvFields

description: CSV output format: escape fields containing delimiter character

default: false


key: only

description: export deps. or deps/dev-/opt-/peer- deps. falsey -> output everything


key: registry

description: NPM registry URL


key: exclude

description: package names that will be excluded from the report


key: fields

description: fields participating in the report and their order

enum: department relatedTo name licensePeriod material licenseType link remoteVersion installedVersion author


key: comment

default: comment


key: package

description: path to the package.json


description: Configuration file for a CFML package

enum: railo lucee adobe

type: object string

format: email

enum: caching cf-engines cfbuilder-extensions cfwheels-plugins cms commandbox-commands commandbox-modules commandbox-recipes contentbox-modules contentbox-themes contentbox-widgets demos di interceptors logging lucee-extensions messaging-queues modules mvc nosql plugins preside-extensions preside-skeletons projects testing wirebox-aspects wirebox-listeners

type: array string


key: engine

description: CFML engine the package supports


key: type

description: The name of the engine


key: version

description: The semantic version of the engine that is supported


key: dependency

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


key: person

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


key: name

description: Name of the person


key: url

description: URL for the person


key: email

description: Email address of the person


description: The name of the package


key: slug

description: ForgeBox unique slug


description: Semantic version of your package


key: author

description: Author of this package


key: location

description: Location of where to download the package. Overrides ForgeBox location


key: directory

description: Install directory where this package should be placed once installed. If not defined, it installs were the CommandBox command was executed.


key: createPackageDirectory

description: This determines if the container directory will contain a sub-directory according to the package slug name. The default is true


key: packageDirectory

description: This name will be used for the package sub-directory instead of the slug name


key: homepage

description: Project homepage URL


key: documentation

description: Documentation URL


key: repository

description: Source repository


description: The version control system. Popular examples are git, svn, or mercurial


description: The URL at which the repository resides


key: bugs

description: Bug issue management URL


key: shortDescription

description: ForgeBox short description


key: description

description: ForgeBox big description. If not set, it can be taken from a Readme.md, Readme, or Readme.txt


key: instructions

description: Install instructions. If not set, it can be taken from a instructions.md, instructions, or instructions.txt


key: changelog

description: Change log. If not set, it can be taken from a changelog.md, changelog, or changelog.txt


key: type

description: ForgeBox contribution type


key: keywords

description: ForgeBox keywords


key: items

description: ForgeBox keyword


key: private

description: Designates the package as a private ForgeBox package. Private packages are not publicly accessible, but still offer all the benefits of ForgeBox.


key: engines

description: CFML engines the package supports


key: defaultEngine

description: The name of the default CFML engine for the `start` command to use.


key: defaultPort

description: Deprecated. The HTTP port the server will be started on when you use the start command. Use `port` in `server.json` instead.


key: projectURL

description: Default project URL if not using CommandBox start server commands


key: license

description: List of licenses the package can have


description: A license the package can have


description: The license type. For example, MIT.


key: url

description: The URL at which the license resides


key: contributors

description: Contributors to the package


key: installPaths

description: Tracks install locations so uninstall can work. The key is the package name/slug and the value is the path


key: scripts

description: Set of script commands that correspond to the interception points in CommandBox or arbitrary names that can be run with the `run-script` command


key: preInstall

description: Run BEFORE the package is installed


key: onInstall

description: Run WHILE the package is installed


key: postInstall

description: Run AFTER the package is installed


key: preUninstall

description: Run BEFORE the package is uninstalled


key: postUninstall

description: Run AFTER the package is uninstalled


key: preVersion

description: Run BEFORE bump the package version


key: postVersion

description: Run AFTER bump the package version, but BEFORE Git repo is tagged


key: onRelease

description: Run AFTER bump the package version and AFTER Git repo is tagged


key: prePublish

description: Run BEFORE the package is published


key: postPublish

description: Run AFTER the package is published


key: ignore

description: List of file globs to ignore when installing the package similar to .gitignore patterns


key: items

description: Ignore glob pattern


key: testbox

description: TestBox integration


key: runner

description: The URI location of the test runner for an app or several with slug names


description: The runner URIs mapped to slug names


key: labels

description: A list of labels to only include when running the tests


description: A label a spec must have to be ran


key: excludes

description: A list of labels to exclude when running the tests


description: A label to be excluded from the test run


key: cfmigrations

description: Configuration object for CF Migration database settings.


key: migrationsDirectory

description: Location of generated migration files that migration commands will use.


key: connectionInfo


key: defaultGrammar

description: Name of the qb service to use for grammar.


description: The OSS-Review-Toolkit (ORT) provides a possibility to define path excludes and license finding curations for a specific package (dependency) and provenance in a package configuration file. A full list of all available options can be found at https://github.com/oss-review-toolkit/ort/blob/main/docs/config-file-package-configuration-yml.md.

required: pattern reason

type: integer string

required: path concluded_license reason


description: Discord Webhook JSON Schema

format: date-time

required: name value

enum: roles users everyone


key: $schema

description: Allow $schema because additionalProperties is false


key: content

description:
The message contents
Max is 2000 characters


key: username

description:
Override the default username of the webhook
Name cannot contain "clyde"


Override the default avatar of the webhook


key: tts

description:
Whether or not this message will play in TTS
Default is false


key: embeds

description:
Embedded rich content
Max is 6000 characters


key: title

description:
Title of embed
Max is 256 characters


key: description

description:
Description of embed
Max is 4096 characters


key: url

description:
URL of embed
Only support http / https


key: timestamp

description:
Timestamp of embed content
ISO8601 Timestamp


key: color

description:
Color code of the embed
Only support color in decimal
To match embed background color, use 3092790
Default is 2105893


key: footer

description: Footer information


key: text

description:
Footer text
Max is 2048 characters


URL of footer icon
Only support http / https


key: image

description: Image information


description:
Source url of image
Only support http / https


key: thumbnail

description: Thumbnail information


description:
Source url of thumbnail
Only support http / https


key: author

description: Author information


key: name

description:
Name of author
Max is 256 characters


description:
URL of author
Only support http / https


URL of author icon
Only support http / https


key: fields

description: Fields information


key: items

description: Fields information


description:
Name of the field
REQUIRED Max is 256


key: value

description:
Value of the field
REQUIRED Max is 1024


key: inline

description:
Whether or not this field should display inline
Default is false


description: Allowed mentions for the message


key: parse

description: An array of allowed mention types to parse from the content.


key: roles

description:
Array of role_ids to mention
Max is 100 of role_ids
Mutually exclusive with parse roles


key: users

description:
Array of user_ids to mention
Max is 100 of user_ids
Mutually exclusive with parse users


description: This object represents a geometry, feature, or collection of features.

required: geometry properties

enum: Point MultiPoint LineString MultiLineString Polygon MultiPolygon GeometryCollection Feature FeatureCollection

required: type properties


key: geometry

description: A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.

enum: Point MultiPoint LineString MultiLineString Polygon MultiPolygon GeometryCollection


key: feature

description:
A GeoJSON object with the type `Feature` is a feature object.

* A feature object must have a member with the name `geometry`. The value of the geometry member is a geometry object as defined above or a JSON null value.

* A feature object must have a member with the name `properties`. The value of the properties member is an object (any JSON object or a JSON null value).

* If a feature has a commonly used identifier, that identifier should be included as a member of the feature object with the name `id`.


key: linearRingCoordinates

description: A LinearRing is closed LineString with 4 or more positions. The first and last positions are equivalent (they represent equivalent points). Though a LinearRing is not explicitly represented as a GeoJSON geometry type, it is referred to in the Polygon geometry type definition.


key: lineStringCoordinates

description: For type `LineString`, the `coordinates` member must be an array of two or more positions.


key: polygonCoordinates

description: For type `Polygon`, the `coordinates` member must be an array of LinearRing coordinate arrays. For Polygons with multiple rings, the first must be the exterior ring and any others must be interior rings or holes.


key: position

description:
A position is the fundamental geometry construct. The `coordinates` member of a geometry object is composed of one position (in the case of a Point geometry), an array of positions (LineString or MultiPoint geometries), an array of arrays of positions (Polygons, MultiLineStrings), or a multidimensional array of positions (MultiPolygon).

A position is represented by an array of numbers. There must be at least two elements, and may be more. The order of elements must follow x, y, z order (easting, northing, altitude for coordinates in a projected coordinate reference system, or longitude, latitude, altitude for coordinates in a geographic coordinate reference system). Any number of additional elements are allowed -- interpretation and meaning of additional elements is beyond the scope of this specification.


For type `Point`, the `coordinates` member must be a single position.


For type `MultiPoint`, the `coordinates` member must be an array of positions.


For type `LineString`, the `coordinates` member must be an array of two or more positions.

A LinearRing is closed LineString with 4 or more positions. The first and last positions are equivalent (they represent equivalent points). Though a LinearRing is not explicitly represented as a GeoJSON geometry type, it is referred to in the Polygon geometry type definition.


For type `MultiLineString`, the `coordinates` member must be an array of LineString coordinate arrays.


For type `MultiPolygon`, the `coordinates` member must be an array of Polygon coordinate arrays.


description:
A GeoJSON object with type `GeometryCollection` is a geometry object which represents a collection of geometry objects.

A geometry collection must have a member with the name `geometries`. The value corresponding to `geometries` is an array. Each element in this array is a GeoJSON geometry object.


description:
A GeoJSON object with the type `FeatureCollection` is a feature collection object.

An object of type `FeatureCollection` must have a member with the name `features`. The value corresponding to `features` is an array. Each element in the array is a feature object as defined above.


key: type

description: The type of GeoJSON object.


key: crs

description:
The coordinate reference system (CRS) of a GeoJSON object is determined by its `crs` member (referred to as the CRS object below). If an object has no crs member, then its parent or grandparent object's crs member may be acquired. If no crs member can be so acquired, the default CRS shall apply to the GeoJSON object.

* The default CRS is a geographic coordinate reference system, using the WGS84 datum, and with longitude and latitude units of decimal degrees.

* The value of a member named `crs` must be a JSON object (referred to as the CRS object below) or JSON null. If the value of CRS is null, no CRS can be assumed.

* The crs member should be on the top-level GeoJSON object in a hierarchy (in feature collection, feature, geometry order) and should not be repeated or overridden on children or grandchildren of the object.

* A non-null CRS object has two mandatory members: `type` and `properties`.

* The value of the type member must be a string, indicating the type of CRS object.

* The value of the properties member must be an object.

* CRS shall not change coordinate ordering.


description: The value of the type member must be a string, indicating the type of CRS object.


key: href

description: The value of the required `href` member must be a dereferenceable URI.


description: The value of the optional `type` member must be a string that hints at the format used to represent CRS parameters at the provided URI. Suggested values are: `proj4`, `ogcwkt`, `esriwkt`, but others can be used.


key: bbox

description: To include information on the coordinate range for geometries, features, or feature collections, a GeoJSON object may have a member named `bbox`. The value of the bbox member must be a 2*n array where n is the number of dimensions represented in the contained geometries, with the lowest values for all axes followed by the highest values. The axes order of a bbox follows the axes order of geometries. In addition, the coordinate reference system for the bbox is assumed to match the coordinate reference system of the GeoJSON object of which it is a member.


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


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: js-types-syntax

description: Language in which JavaScript objects types are specified.


key: description-markup

description: Markup language in which descriptions are formatted.

enum: html markdown none


key: framework-config

description: Provide configuration for the specified web framework. This is an advanced feature, which is used to provide support for templating frameworks like Angular, Vue, Svelte, etc.


key: canonical-names

description: In many frameworks symbols can have multiple versions of a name. Specify canonical name conversion rule for names of particular symbol kinds against which comparisons will be made. Format of the 'canonical-names' property names is '{namespace}/{symbol kind}'. By default symbol names in HTML namespace are converted to lower-case, and in CSS and JS namespaces are left as-is. In case of name patterns, rules are applied to each part of the pattern separately, so even if the symbol with pattern is in HTML namespace, references to JS events will be case-sensitive.


key: match-names

description: Provide an array of name conversions, in which particular symbol kinds should be matched against canonical names of symbols. By default symbol names are converted using canonical-names rule.


key: name-variants

description: Provide an array of name conversions, in which particular symbol kinds should be proposed in auto completion. Format of the 'name-variants' property names is '{namespace}/{symbol kind}'. All symbol kinds are by default provided as-is.


key: enablement-rules

description: Specify rules for enabling web framework support. Only one framework can be enabled in a particular file. If you need your contributions to be enabled in all files, regardless of the context, do not specify the framework.


key: node-packages

description: Node.js package names, which enable framework support within the folder containing the package.json.


key: script-url-patterns

description: RegExps to match script URLs, which enable framework support within a particular HTML.


key: file-extensions

description: Extensions of files, which should have the framework support enabled. Use this to support custom file extensions like '.vue' or '.svelte'. Never specify generic extensions like '.html', '.js' or '.ts'. If you need your contributions to be present in every file don't specify the framework at all


key: file-name-patterns

description: RegExp patterns to match file names, which should have the framework support enabled. Use carefully as broken pattern may even freeze IDE.


key: ide-libraries

description: Global JavaScript libraries names enabled within the IDE, which enable framework support in the whole project


key: disablement-rules

description: Specify rules for disabling web framework support. These rules take precedence over enable-when rules. They allow to turn off framework support in case of some conflicts between frameworks priority.


description: Extensions of files, which should have the framework support disabled


description: RegExp patterns to match file names, which should have the framework support disabled


key: icon

description: Relative path to the icon representing the symbol.


key: base-contribution

description: The base for any contributions.


key: typed-contribution

description: The base for any contribution, which can possibly have a JS type.


key: generic-contribution

description: A generic contribution. All contributions are of this type, except for HTML attributes and elements, as well as predefined CSS contribution kinds.


key: type-list

description: Specify type according to selected language for type syntax. The type can be specified by a string expression, an object with list of imports and an expression, or an array of possible types.


key: module

description: Name of module, which exports the type. May be omitted, in which case it's assumed to be the name of the library.


key: name

description: Name of the symbol to import


key: html-value-type

description: Provide one of special attribute value types:  "enum", "of-match", or a simple JavaScript type according to the specified type format.


key: source

description: Allows to specify the source of the entity. For Vue.js component this may be for instance a class.

required: file offset


key: file

description: Path to the file, relative to the web-types JSON.


key: offset

description: Offset in the file under which the source symbol, like class name, is located.


description: Name of module, which exports the symbol. May be omitted, in which case it's assumed to be the name of the library.


key: symbol

description: Name of the exported symbol.


key: description

description: Short description to be rendered in documentation popup. It will be rendered according to description-markup setting.


key: description-sections

description: Custom sections to be shown below description in the documentation popup.


key: doc-url

description: Link to online documentation.


key: virtual

description: Mark contribution as virtual. Virtual contributions can be filtered out if needed in references. A virtual contribution meaning may differ by framework or kind contexts, but usually means something synthetic or something, which gets erased in the runtime by the framework. E.g. Vue or Angular attribute bindings are virtual.


key: abstract

description: Mark contribution as abstract. Such contributions serve only as super contributions for other contributions.


key: extension

description: Mark contribution as an extension. Such contributions do not define a new contribution on their own, but can provide additional properties or contributions to existing contributions.


key: exclusive-contributions

description:
Specify list of contribution kinds qualified with a namespace, for which during reference resolution this will be the final contribution host. E.g. if a special HTML element does not accept standard attributes, add:
"exclusive-contributions": ["/html/attributes"].


key: list-reference

description: A reference to an element in Web-Types model.


key: reference


key: pattern

description: A RegEx pattern to match whole content. Syntax should work with at least ECMA, Java and Python implementations.


key: elements

description: HTML elements.


key: attributes

description: HTML attributes.


key: events

description: DOM events are deprecated in HTML namespace. Contribute events to JS namespace: /js/events


key: html

description: Contains contributions to HTML namespace. It's property names represent symbol kinds, its property values contain list of contributions of particular kind. There are 2 predefined kinds, which integrate directly with IDE - HTML elements and HTML attributes. There are also 2 deprecated kinds: tags (which is equivalent to 'elements') and 'events' (which was moved to JS namespace)

deprecationMessage: Use `elements` property.


key: tags

description: Deprecated, use `elements` property.


key: vue-modifiers

description: Deprecated vue-specific property - contribute Vue directives to /contributions/html/vue-directives

deprecationMessage: Contribute Vue directives to /contributions/html/vue-directives


key: properties

description: CSS properties


key: pseudo-elements

description: CSS pseudo-elements


key: pseudo-classes

description: CSS pseudo-classes


key: functions

description: CSS functions


key: classes

description: CSS classes


key: css

description: Contains contributions to CSS namespace. It's property names represent symbol kinds, its property values contain list of contributions of particular kind. There are 5 predefined kinds, which integrate directly with IDE - properties, classes, functions, pseudo-elements and pseudo-classes.


key: arguments

description: Specify whether the pseudo-element requires arguments.


description: Specify whether the pseudo-class requires arguments.


description: DOM events


description: JavaScript properties of an object, HTML tag, framework component, etc.


key: js

description: Contains contributions to JS namespace. It's property names represent symbol kinds, its property values contain list of contributions of particular kind. There are 2 predefined kinds, which integrate directly with IDE - properties and events.


key: deprecated-types-syntax

description: Deprecated, use top-level js-types-syntax property.

deprecationMessage: Use top-level js-types-syntax property.


key: deprecated-description-markup

description: Deprecated, use top-level property.

deprecationMessage: Use top-level property.


key: deprecated-html-attribute-vue-argument


key: required

description: Whether directive requires an argument


key: framework

description: Framework, for which the components are provided by the library. If the library is not enabled in a particular context, all symbols from this file will not be available as well. If you want symbols to be always available do not specify framework.


key: name

description: Name of the library.


key: version

description: Version of the library, for which Web-Types are provided.


key: contributions

description: Symbol can be contributed to one of the 3 namespaces - HTML, CSS and JS. Within a particular namespace there can be different kinds of symbols. In each of the namespaces, there are several predefined kinds, which integrate directly with IDE, but providers are free to define their own.


description: Configuration Schema for the JavaScript test runner AVA

enum: commonjs module

default: cjs mjs js


key: files

description: An array of glob patterns to select test files. Files with an underscore prefix are ignored. By default only selects files with `cjs`, `mjs` & `js` extensions, even if the pattern matches other files. Specify `extensions` to allow other file extensions


key: ignoredByWatcher

description: An array of glob patterns to match files that, even if changed, are ignored by the watcher


key: match

description: Not typically useful in the `package.json` configuration, but equivalent to specifying `--match` on the CLI


key: cache

description: Defaults to `true` to cache compiled files under `node_modules/.cache/ava.` If `false`, files are cached in a temporary directory instead


key: concurrency

description: Max number of test files running at the same time (default: CPU cores)


key: workerThreads

description: Use worker threads to run tests (enabled by default). If `false`, tests will run in child processes


key: failFast

description: Stop running further tests once a test fails


key: failWithoutAssertions

description: If `false`, does not fail a test if it doesn't run assertions


key: environmentVariables

description: Specifies environment variables to be made available to the tests. The environment variables defined here override the ones from `process.env`


key: tap

description: If `true`, enables the TAP reporter


key: verbose

description: If `true`, enables verbose output (though currently non-verbose output is not supported)


key: snapshotDir

description: Specifies a fixed location for storing snapshot files. Use this if your snapshots are ending up in the wrong location


key: extensions

description: Extensions of test files. Setting this overrides the default `["cjs", "mjs", "js"]` value, so make sure to include those extensions in the list. Experimentally you can configure how files are loaded


key: require

description: Extra modules to require before tests are run. Modules are required in the worker processes


key: timeout

description: Timeouts in AVA behave differently than in other test frameworks. AVA resets a timer after each test, forcing tests to quit if no new test results were received within the specified timeout. This can be used to handle stalled tests. See our timeout documentation for more options


key: nodeArguments

description: Configure Node.js arguments used to launch worker processes


key: utilizeParallelBuilds

description: If `false`, disable parallel builds (default: `true`)


key: typescript

description: Configures @ava/typescript for projects that precompile TypeScript. Alternatively, you can use `ts-node` to do live testing without transpiling, in which case you shouldn't use the `typescript` property


description: You can configure AVA to recognize additional file extensions as TypeScript (e.g., `["ts", "tsx"]` to add partial JSX support). Note that the preserve mode for JSX is not (yet) supported. See also AVA's `extensions` object


key: rewritePaths

description: AVA searches your entire project for `*.js`, `*.cjs`, `*.mjs` and `*.ts` files (or other extensions you've configured). It will ignore such files found in the `rewritePaths` targets (e.g. `build/`). If you use more specific paths, for instance `build/main/`, you may need to change AVA's `files` configuration to ignore other directories. Paths are relative to your project directory


key: compile

description: If `false`, AVA will assume you have already compiled your project. If set to `'tsc'`, AVA will run the TypeScript compiler before running your tests. This can be inefficient when using AVA in watch mode


key: dns

description: Project-wide DNS setup.


key: state

description: Project-wide state source.


key: secrets

description: Project-wide secrets provider.


key: dependencies

description: Project-wide dependencies to provision.


key: monitoring

description: Project monitoring setup.


key: plugins

description: Project-wide plugins.


key: defaults

description: Project-wide default app settings.


key: ssl

description: SSL configuration.


description: Public key file path. Required to be in PEM format.


description: Private key file path. Required to be in PEM format.


key: cert

description: Public key value in PEM format.


key: key

description: Private key value in PEM format.


key: type

description: State type, plugin specific value e.g. 'gcp' for gcp plugin or use 'local' for local state.


key: path

description: Path of local state, used only when state type is 'local'.


description: Secrets provider type, plugin specific value e.g. 'gcp' for gcp plugin.


description: The type of the dependency.


key: deploy

description: Deploy config.


key: run

description: Run config.


key: versioning

description: Enables versioning for objects.


key: location

description: Specify location for storage, refer to cloud provider docs for possible options.


key: public

description: Makes whole storage public so that all objects can be accessed.


description: Maximum amount of versions to keep.


description: Delete new objects after X days.


description: Expire archived versions after X days.


key: cors

description: CORS settings.


key: version

description: Specify version of database, refer to cloud provider docs for possible options.


description: Makes database highly available meaning it will have a read replica available in case of master failure.


key: tier

description: Specify tier of database, refer to cloud provider docs for possible options.


key: flags

description: Database flags, refer to cloud provider docs for possible options.


key: users

description: Database users.


key: password

description: Explicitly set password, defaults to a randomly generated string.


key: hostname

description: Hostname that user is allowed to connect from. Not all databases may support it.


key: origins

description: The list of Origins eligible to receive CORS response headers. Note: "*" is permitted in the list of origins, and means "any Origin".


key: methods

description: The list of HTTP methods on which to include CORS response headers, (GET, OPTIONS, POST, etc) Note: "*" is permitted in the list of methods, and means "any method".


description: The list of HTTP headers other than the simple response headers to give permission for the user-agent to share across domains.


description: The value in seconds to return in the Access-Control-Max-Age header used in preflight responses.


key: plugin

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


key: channels

description: Monitoring notification channels.


key: targets

description: Monitoring targets.


key: type

description: Notification channel type. Possible values: slack, email.

enum: slack email


key: token

description: Bot user oauth token used for slack notification.


key: channel

description: Channel used for slack notification.


key: email

description: Email used for email channel type.


key: url

description: Target full url.


key: frequency

description: Check frequency in minutes. Defaults to 5 minutes.


key: locations

description: Check locations to use. Defaults to 'all'.


key: deploy

description: Deploy config.


key: dns

description: DNS config.


key: run

description: Run config.


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


key: env

description: Additional environment variables added to every app that supports environment variables.


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


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


key: enabled

description: Enable this default header action


key: name

description: Name of the default header action


key: apache

description: Expert settings for the Apache httpd.


Expert settings for the Security Gate.


description: Whether to ignore case.

default: true


key: inverted

description: Whether to invert the match.


key: pattern

description: A regex pattern used to match, cannot be empty. If you need a pattern that matches every string use ".*"


key: regex

description: The regular expression, which matches the parts which should be rewritten.


key: substitution

description: The rewrite expression.


description: A pattern for the header name.


key: value

description: A pattern for the header value.


key: replace

description: A string to rewrite the header value with. Can make back-references to the header value pattern.


description: The name of the header to add.


description: The value of the header to add.


description: The actual pattern.


key: audittoken

description: If the 'sub' claim should be extracted from the JWT and be used as audit token of the current session


key: claims

description: All specified claims are checked and must match the claim's value of the decoded token. If a claim is an array, at least one entry must match the specified regex.


key: claim

description: The name of the claim you want to restrict.


description: The regular expression that must match the value of the specified claim name.


description: If the JWT standard claims expiry (exp) and not before (nbf) will be checked and must be valid.


key: extraction

description: How the token should be extracted.

enum: header parameter cookie

default: header


key: cookie

description: From which cookie the token should be extracted.


key: header

description: How the token should be extracted from the request headers.


key: mode

description: From which part of the request the token should be extracted. Possible values are 'header', 'parameter', 'cookie'.


key: parameter

description: From which query parameter the token should be extracted.


description: List of JWKS service providers referenced by their name. Can be local or remote providers.


key: mandatory

description: If disabled, requests without a token are accepted. However, if a token is present,it is extracted and validated and the configured restrictions and role extractions are applied.


key: roles

description: Specifies which roles should be extracted from the claims.


description: Name of the claim you want to extract a role from.


description: The regular expression to match the role extraction and the rewrite expression of the role.


description: If enabled, the expiry claim (exp) of the JWT will be used as the role lifetime.


description: Enforce a signed JWT


key: skew

description: The allowed skew when checking expiry / not before in seconds.


The claim to extract the technical client id from.


A pattern to match the content type for this allow rule.


key: enabled

description: Enable the allow rule.


description: Whether to log requests not matching this allow rule instead of blocking them.


key: method

description: A pattern to match the http method for this allow rule.


key: name

description: Unique name for the allow rule. If omitted, a unique name will be generated. To enable/disable the default allow rule or one from a mapping_template_file, use the same name.

default: Allow all


key: path

description: A pattern to match the path.


description: JSON objects are parsed only if their content-type matches the specified pattern.


key: openapi

description: The specification to validate against.


description: If enabled, potential attack requests are only logged but not blocked.


description: The Microgateway mapping can be configured to rewrite the incoming URL to a different back-end URL (asymmetric mappings). Due to this rewriting, the incoming URL path (client_view) will be different from the back-end URL path (backend_view).


description: Check responses against API specification.


key: spec

description: The OpenAPI specification.


The OpenAPI file path.


description: If enabled, Microgateway parses JSON objects in requests and filters JSON attributes with allow rules and deny rules.


description: If enabled, each path segment is interpreted as a separate parameter value and the deny rules for parameter values are applied to it.


key: access

description: A list of access restrictions can be created. Each request matching the combination of HTTP method and path of a access restriction must have at least one of the specified roles to access the service. All matching restrictions must be satisfied to gain access.


description: Can contain regular expressions that are applied when the HTTP method of a request matches one of the expressions. Use an empty pattern if all HTTP methods should match.


description: Can contain regular expressions that are applied when the requested path of the query matches the expressions. Use an empty pattern if all paths should match.


description: Can contain a list of roles for this service. Only sessions that have at least one of these roles will be able to access the service.


key: verification

description: The client certificate verification mode to use on this mapping. This can be used to override the setting from the virtual host with a stronger verification level (e.g. off -> optional or optional -> required). Possible values are 'inherit', 'optional' or 'required'.

enum: inherit optional required

default: inherit


Defines the location of the authentication service. In case the required role for the mapping is missing on the current session, Airlock Gateway will redirect the client to this location. If this value is missing (default), the Global Denied Access URL will be used.


key: flow

description: The authentication flow, allowed values are: redirect, deny_access, one_shot, one_shot_with_body, ntlm

default: redirect


In order to allow clean session termination on back-end systems when an Airlock Gateway session terminates, the administrator can configure one logout path per mapping.


Expert settings for the Security Gate.


description: The hostname of the back-end host. Only characters a-Z, numbers, and the special characters '.', ':',  '-' and '_' are allowed.

default: backend


key: port

description: Configuring a back-end port.


key: protocol

description: Allowed values are: http, https

enum: https http

default: http


description: The unique name of the back-end. Only characters a-Z, numbers, and the special characters '.', ':',  '-' and '_' are allowed.

default: backendGroup


The back-end path specifies the internal back-end path, i.e. the path of the request sent to the application server.


description: Specifies whether Airlock Microgateway should compress the output on-the-fly for the client browser if supported and requested by the browser.


description: Specifies whether the connected back-end service is allowed to use the Airlock Microgateway Control API via the control cookie mechanism. The Control API is normally used by authentication applications to communicate with the Microgateway.


key: encrypted

description: Cookies that should be cryptographically encrypted before being sent to the client.


key: passthrough

description: Cookies that should be passed in plain format to the client.


description: Whether to enable automatic CSRF token injection and validation on this mapping.


key: exceptions

description: All incoming URLs that match one of these patterns are accepted by Airlock Microgateway without a valid CSRF token.


description: Specifies the location (e.g. /index.html) to which the client is redirected if a missing or invalid CSRF token is detected.

default: /%ENTRYPATH%


description: Enable deny rule group


key: level

description: Allowed values are: basic, standard, strict.

enum: basic standard strict

default: standard


description: If enabled, offending requests are not blocked but only logged


description: If deny rule group key is defined, the settings will only affect the specific deny rule group.


description: The entry path specifies the external URL path the mapping should be available under.

enum: directory regex

default: directory


description: Whether a trailing slash is mandatory at the end of the entry path or not.


description: Whether to ignore case.


key: type

description: Allowed values are: directory, regex.


key: value

description: This specifies the external URL path.


description: Specifies whether Airlock environment cookies containing useful request information are sent to the connected back-end.


The limits for HTTP parameters.


Defines the maximum length of a parameter name in bytes.


Defines the maximum length for a parameter value in bytes.


Defines the maximum number of parameters inside the request.


A regular expression which specifies any parameters which should not be checked against these length checks.


The limits for JSON structures.


Defines the maximum number of items in a single JSON array (non-recursive).


Defines the maximum length for a JSON key, also known as 'JSON property' or 'JSON object member' in bytes.


Defines the maximum number of keys of a single JSON object (non-recursive).


Defines a regular expression to exclude JSON keys and the corresponding values from the length checks. The exceptions must be specified in the '#json' format for a JSON key.


Defines the maximum depth of nesting for JSON objects and JSON arrays.


Defines the maximum number of keys and array items in the whole JSON document (recursive).


Defines the maximum length for a JSON value (string or numbers) in bytes.


Defines the maximum path length for requests to the current mapping in bytes.


The maximum allowed total size of the request body in bytes. It specifies the number of bytes from 0 (meaning unlimited) to 2147483647 (2GB) that are allowed in the request body. To restrict the size of file uploads, set this limit to the maximum combined size of all files uploaded at once.


The Airlock Gateway mapping template file path.


description: The unique name of the mapping.

default: root


description: Allowed values are: production, integration.

enum: production integration

default: production


description: If enabled, requests are blocked if they contain the same parameter names with different parameter types (e.g. "id" is present as a POST parameter and as a query parameter simultaneously).


description: If enabled, offending requests are not blocked but only logged.

default: false


Exception pattern to exclude parameters from the parameter pollution detection.


description: If enabled, all the different values of a repeated parameter are joined by comma (in order of appearance). The aggregate value is then checked against deny rules (instead of the individual values).


key: priority

description:
Specifies the priority of this mapping (highest: -999, lowest: 999) when a request matches the entry path of multiple mappings.
All mappings with entry_path.type regex must have a unique priority.


description: A list of request custom actions executed in order of appearance. Only one action type (e.g. add_header or header_redirect) can be specified in each entry. Create multiple list positions if needed.


An action to add a header to all requests.


An action to add a header to all requests if it is not already present.


An action to add or replace an existing header to all requests.


description: An action to redirect to a URL based on the geographic location of the request source IP.


description: A list of alpha-2 continent codes to redirect clients from. See here: https://en.wikipedia.org/wiki/List_of_sovereign_states_and_dependent_territories_by_continent_(data_file)


description: A list of country codes to redirect clients from. See here for alpha-2 codes to use: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2


The http status code to use on redirect


The url to redirect to.


An action to redirect to a URL based on a header name or value either matching the given name or value pattern on requests.


description: A pattern for the header name.


description: A pattern for the header value.


description: A unique name for this action; if not specified, a unique name will be generated.


An action to remove a header either matching given name or value pattern on requests.


An action to rewrite a header value either matching given name or value pattern on requests.


enum: auto keep remove add

default: auto


An action to add a header to all responses.


An action to add a header to all responses if it is not already present.


An action to add or replace an existing header on all responses.


An action to remove a header either matching given name or value pattern on responses.


description: An action to rewrite a cookie based on patterns for cookie name, domain etc.


key: cookie

description: A pattern to match the name of the cookie to rewrite. If this is set the name of the cookie must match this pattern for the rewrite to happen.


key: domain

description: A pattern to match the domain, or part of the domain of a cookie to rewrite it.


What to replace the domain with; Can make back references to the pattern used to match.


description: Whether to `add`, `keep` or `remove` the `HttpOnly` (see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#HttpOnly) flag on cookies. AUTO will set the flag for encrypted cookies and KEEP it for others.


key: path

description: A pattern to match the path of a response to rewrite.


What to replace the path with; Can make back references to the pattern used to match.


description: Whether to `add`, `keep` or `remove` the `Secure` (see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#Secure) flag on cookies. AUTO will set the flag on all connections that use HTTPS and remove it on others.


An action to rewrite a header value either matching given name or value pattern on responses.


An action to rewrite the raw value of a cookie matching the given pattern.


key: replace

description: A string to rewrite value pattern matches in the cookie value. Can make back references to the pattern used for matching.


description: A pattern for the cookie value to apply for matching.


description: Replacement rules for error responses returned by backend systems.


key: page

description: Error page file name that will be delivered to the client. (eg. 400.html)


The http response with the matching status code that should be replaced.


key: any

description: Rewrite the body of HTTP response.


key: content

description: This regular expression pattern defines the content to rewrite.


description: A response from the back-end server is rewritten only if the response header «Content-Type» matches this regular expression.


key: to

description: This is the target string which will replace the string matched by Content Pattern


key: html

description: Rewriting HTML content may be necessary to modify URLs in the HTML content if the application creates absolute or incorrect links because it is not reverse proxy compatible

default: [ url ]

enum: url event embedded


key: options

description: This list defines the content to rewrite. Possible values are 'url', event', 'embedded'.


description: This is the target string which will replace the string matched by URL Pattern


key: url

description: The URL pattern.


key: json

description: Rewrite the json body of http responses.


description: The json path of the the property to rewrite.


description: This is the target content to replace the matched part with.


description: Rewrite option to modify the HTTP redirect location header sent from the back-end server before it is sent to the client.


description: The redirect URL pattern.


description: Allowed values are: enforce_session, optional_session, optional_session_no_refresh, ignore_session


description: Allowed values are: block, terminate_session, notify.

enum: terminate_session block notify

default: block


Defines the time in seconds Airlock Microgateway will wait for the back-end HTTP response. In case the request runs into the timeout, Airlock Microgateway will deliver an error page with the corresponding HTTP 503 status code.


Defines the minimum session idle time in seconds for this mapping. The value will be ignored if minimum session idle timeout is smaller or equal to the global session idle timeout setting.


key: aliases

description: Additional hostnames which refer to this virtual host.


The concatenated certificates of the CAs which are sent to the client during the SSL handshake, in PEM format.


The file containing the selection CA certificates.


The concatenated certificates of the CAs which are used as trust anchor during chain validation, in PEM format.


The file containing the validation CA certificates.


key: crl

description: PEM representation of certificate revocation lists. If a client certificate is on such a list it will not be accepted. Although Airlock provides this functionality, it is recommended to check certificates against CRLs and other types of blacklists within the authentication service and not in Airlock.


The file containing the crl.


key: verification

description: Defines the default verification mode for client certificates on this virtual host. Possible values are 'off', 'optional' or 'required'.

enum: off optional required

default: off


description: Maximum number of intermediate certificate issuers.


List of certificates of the CA chain for the certificate.


The CA chain file path.


key: certificate

description: The certificate in PEM format.


The certificate file path.


key: privatekey

description: The private key for the certificate in PEM format.


The private key file path


description: Specifies whether encoded slashes (%2F) are allowed in URL path. Attention: combinations of client certificates per mapping and enabled encoded slashes in the same virtual host might result in configurations where client certificate evaluation might be evaded.


key: hostname

description: The hostname of the virtual host.

default: microgateway


description: Specifies whether HTTP/2 connections are enabled for this host.

default: true


description: Specifies whether HTTP connections are enabled for this host.


description: Specifies the port on which this host listens for HTTP connections.


description: Specifies whether HTTPS connections are enabled for this host.


description: Specifies the port on which this host listens for HTTPS connections.


key: name

description: The logical name of the virtual host.


key: dest

description: The destination can be relative to the current virtual host or an absolute URL including protocol and host. Relative redirect paths are extended with the incoming scheme and host header.


key: path

description: The absolute path starting with '/' as a regular expression from which to redirect.


description: The returned status code. Must be one of: [301, 302, 303, 307, 308]


Specifies the domain for Airlock's session cookie if the cookie is created inside this virtual host.


description: Specifies the cookie path for Airlock's session cookie if the cookie is created inside this virtual host.


description: Specifies whether a virtual host should reply only to requests that match the hostname or any of its server alias names.


description: Custom deny rule groups that can be referenced in mappings on top of the built in Airlock deny rules.


description: Filter rule that blocks requests based on the evaluation of different request attributes.


description: Unique name. In order to prevent overriding built-in deny rules, the name may not start with '(default)'.


description: Unique short name. In order to prevent overriding built-in deny rules, the name may not start with '(default)'.


description: Unique name. In order to prevent overriding built-in deny rule group, the name may not start with '(default)'.


description: Unique short name. In order to prevent overriding built-in deny rule group, the name may not start with '(default)'.


description: JWKS Providers which can be referenced in apps[].mappings[].access_token.

default: DEFAULT


key: local

description: JWKS providers that are configured statically.


key: issuer

description: Name of JWKS issuer. Corresponds to the 'Issuer' field in JWT.


key: jwks

description: JSON Object that represents the set of JWKS.


JSON file with the definitions of JWKS.


description: Name by which provider is referenced. Must be unique.