jshintrc.json

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

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

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

description: The ECMAScript version to which the code must adhere

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

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

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

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

description: Suppresses warnings about the __iterator__ property.

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

description: Prohibits unnecessary clauses within `switch` statements

description: Max cyclomatic complexity per function

type: boolean integer

description: Max depth of nested blocks

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

description: Max number of formal parameters allowed per function

description: Max number statements per function

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

description: Prohibits the use of the comma operator

description: Warns about `non-breaking whitespace` characters

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

description: Suppresses warnings about invalid `typeof`operator values

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

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

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

type: boolean string

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

description: Requires all code to run in ES5 strict mode

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

description: Prohibits the use of explicitly undeclared variables

description: Warns when you define and never use your variables

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

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

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

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

description: Suppresses warnings about `== null` comparisons

description: Suppresses warnings about the use of `eval`

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

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

description: Suppresses warnings about functions inside of loops

description: Tells JSHint that your code uses Mozilla JavaScript extensions

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

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

description: Suppresses warnings about the `__proto__` property

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

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

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

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

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

description: [Environment] Browserify

description: [Environment] CouchDB

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

description: [Environment] Dojo Toolkit

description: [Environment] Jasmine unit testing framework

description: [Environment] jQuery

description: [Environment] Mocha unit testing framework

description: [Environment] ES6 module

description: [Environment] MooTools

description: [Environment] Node.js

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

description: [Environment] PhantomJS runtime environment

description: [Environment] Prototype JavaScript framework

description: [Environment] Rhino

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

description: [Environment] Defines globals for typed array constructors

description: [Environment] Web Workers

description: [Environment] Windows Scripting Host

description: [Environment] Yahoo User Interface

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

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

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

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

title: JSON schema for JSHint configuration files


liquibase-flow-file-latest.json

title: Liquibase Flow File

type: object

$ref: #/$defs/variable

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.

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.

$ref: #/$defs/stage

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.

type: string

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.

type: array

$ref: #/$defs/action

description: The actions to run in this stage.

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

additionalProperties: false

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

type: number string boolean object array null


fabric.mod.json

description: The language adapter to use

default: default

description: The entrypoint function or class

description: The entrypoint function or class

description: Contact e-mail pertaining to the mod

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

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

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

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

description: Custom contact or profile informations

enum: * client server

description: The environment where this mod will be loaded

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

description: The name of the person

description: The name of the person

description: Contact information for the person

$ref: #/definitions/contactInfo

$ref: #/definitions/versionRange

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

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.

markdownDescription:
A version range or an array of those that match versions. The following variants are supported:

- `*` matches any version.
- Ranges following [NPM semver specification](https://docs.npmjs.com/about-semantic-versioning):
  - `>=`, `>`, `=`, `<` 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.

description: The mod identifier

description: The mod version

type: integer

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

$ref: #/definitions/environment

$ref: #/definitions/entrypoint

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

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

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

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

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

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

description: Custom mod entrypoints

description: The entrypoints used by this mod

description: Contains an array of nestedJar objects

$ref: #/definitions/nestedJar

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

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

description: Path to an access widener definition file

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

$ref: #/definitions/versionRanges

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

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

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

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

description: Name of the mod

description: Description of the mod

$ref: #/definitions/person

description: The direct authorship information

description: Contributors to this mod

description: Contact information for the mod

description: The license the mod uses

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

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

required: id version schemaVersion


license-report-config.json

description: license report output format

description: HTML output format

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

description: CSV output format

default: false

description: CSV output format: escape fields containing delimiter character

type: boolean

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

description: NPM registry URL

description: package names that will be excluded from the report

description: fields participating in the report and their order

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

default: comment

type: number

description: path to the package.json

title: JSON schema for license report tool configuration file


drupal-links-task.json

title: The static title for the local task

title: The translation context for the title value.

title: The name of the route this task links to

title: Parameters for route variables when generating a link

title: The route name where the root tab appears

title: The plugin ID of the parent tab

title: The weight of the tab

title: Array of link options

title: Class for task implementations

title: Deriver class

title: Cache tags

title: JSON schema for Drupal task links file


box.schema.json

description: CFML engine the package supports

title: Engine Type

description: The name of the engine

enum: railo lucee adobe

title: Engine Version

description: The semantic version of the engine that is supported

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

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

type: object string

description: Name of the person

description: URL for the person

format: uri

description: Email address of the person

format: email

title: Package Manifest

description: Configuration file for a CFML package

title: Name

description: The name of the package

title: Slug

description: ForgeBox unique slug

title: Version

description: Semantic version of your package

title: Author

description: Author of this package

title: Location

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

title: Directory

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

title: Create Package Directory

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

title: Package Directory

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

title: Homepage

description: Project homepage URL

title: Documentation

description: Documentation URL

title: Repository

description: Source repository

title: Repository Type

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

title: Repository URL

description: The URL at which the repository resides

title: Bugs

description: Bug issue management URL

title: Short Description

description: ForgeBox short description

title: Description

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

title: Instructions

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

title: Change Log

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

title: Type

description: ForgeBox contribution type

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

title: Keywords

description: ForgeBox keywords

type: array string

title: Keyword

description: ForgeBox keyword

title: Private

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

title: Engines

description: CFML engines the package supports

$ref: #/definitions/engine

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

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

title: Project URL

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

title: Licenses

description: List of licenses the package can have

title: License

description: A license the package can have

title: License Type

description: The license type. For example, MIT.

title: License URL

description: The URL at which the license resides

title: Contributors

description: Contributors to the package

$ref: #/definitions/dependency

title: Install Paths

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

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

description: Run BEFORE the package is installed

description: Run WHILE the package is installed

description: Run AFTER the package is installed

description: Run BEFORE the package is uninstalled

description: Run AFTER the package is uninstalled

description: Run BEFORE bump the package version

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

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

description: Run BEFORE the package is published

description: Run AFTER the package is published

title: Ignore

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

description: Ignore glob pattern

title: TestBox

description: TestBox integration

title: TestBox Runner

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

type: string array

description: The runner URIs mapped to slug names

title: Labels List

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

description: A label a spec must have to be ran

title: Exclude List

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

description: A label to be excluded from the test run

title: CF Migrations

description: Configuration object for CF Migration database settings.

title: Migrations Directory

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

title: Database Schema

title: Migrations Directory

title: Database Password

title: Database Connection String

title: Database class

title: Database Username

title: Default Grammar

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


package-configuration-schema.json

title: ORT package configuration

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.

$ref: #/definitions/licenseFindingCurations

$ref: #/definitions/pathExcludeReason

required: pattern reason

$ref: #/definitions/vcsMatcher

type: integer string

required: path concluded_license reason


webhook.json

title: Discord Webhook

description: Discord Webhook JSON Schema

$ref: #/definitions/string

description: Allow $schema because additionalProperties is false

description:
The message contents
Max is 2000 characters

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

description: Override the default avatar of the webhook

$ref: #/definitions/url

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

$ref: #/definitions/boolean

description:
Embedded rich content
Max is 6000 characters

description:
Title of embed
Max is 256 characters

description:
Description of embed
Max is 4096 characters

description:
URL of embed
Only support http / https

description:
Timestamp of embed content
ISO8601 Timestamp

format: date-time

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

description: Footer information

description:
Footer text
Max is 2048 characters

description:
URL of footer icon
Only support http / https

description: Image information

description:
Source url of image
Only support http / https

description: Thumbnail information

description:
Source url of thumbnail
Only support http / https

description: Author information

description:
Name of author
Max is 256 characters

description:
URL of author
Only support http / https

description:
URL of author icon
Only support http / https

description: Fields information

description: Fields information

required: name value

description:
Name of the field
REQUIRED Max is 256

description:
Value of the field
REQUIRED Max is 1024

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

description: Allowed mentions for the message

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

enum: roles users everyone

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

$ref: #/definitions/id

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


geojson.json

title: Coordinates

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

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

required: geometry properties

title: Geometry

$ref: #/definitions/geometry

title: Properties

title: Linear Ring Coordinates

$ref: #/definitions/lineStringCoordinates

title: Line String Coordinates

$ref: #/definitions/coordinates

$ref: #/definitions/position

title: Polygon Coordinates

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.

$ref: #/definitions/linearRingCoordinates

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

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

title: Point

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

title: Multi Point Geometry

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

title: Line String

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

title: MultiLineString

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

title: Polygon

$ref: #/definitions/polygonCoordinates

title: Multi-Polygon Geometry

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

title: Geometry Collection

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.

title: Geometries

$ref: #/definitions/feature

title: Feature Collection

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.

title: Features

title: Type

description: The type of GeoJSON object.

enum: Point MultiPoint LineString MultiLineString Polygon MultiPolygon GeometryCollection Feature FeatureCollection

title: Coordinate Reference System (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.

required: type properties

title: CRS Type

title: CRS Properties

title: Link Object

title: href

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

title: Link Object Type

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.

title: Bounding Box

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.

title: GeoJSON Object


cryproj.dev.schema.json

$comment: JSON Schema for CRYENGINE dev

title: Variable name

description: CVar name

title: Command name

description: Console command name

$ref: #/definitions/cvars

title: Value of the CVar

description: The default value of the CVar

title: Assets folder

description: This indicates where the assets are stored

default: Assets

title: Code folder

description: This indicates where the code is stored

default: Code

title: Lib's name

title: Lib's name to import for all the supported platforms

title: Lib's name to import for the win_x64 platform

title: Lib's name to import for the win_x86 platform

title: Project name

description: This indicates the project name

title: Project GUID

title: Engine version

description: This indicates which engine version will be used

title: Plugin name

description: Required plugin's name

examples: CryDefaultEntities CrySensorSystem CryPerceptionSystem CryUserAnalytics CryOSVR CryOculusVR CryOpenVR CryLobby

title: Plugin type

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

title: This plugin will be used only by these platforms

enum: pc ps4 xboxone linux

required: path type

title: Project version

$ref: #/definitions/commands

title: Value of the command

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

required: content info require version

title: CryProj schema


web-types.json

description: Language in which JavaScript objects types are specified.

description: Markup language in which descriptions are formatted.

enum: html markdown none

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.

$ref: #/definitions/enablement-rules

$ref: #/definitions/disablement-rules

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.

$ref: #/definitions/name-converter

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.

$ref: #/definitions/name-converters

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.

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.

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

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

$ref: #/definitions/pattern

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

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

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

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

enum: as-is PascalCase camelCase lowercase UPPERCASE kebab-case snake_case

description: Relative path to the icon representing the symbol.

description: The base for any contributions.

$ref: #/definitions/name

$ref: #/definitions/description

$ref: #/definitions/description-sections

$ref: #/definitions/doc-url

$ref: #/definitions/icon

$ref: #/definitions/source

$ref: #/definitions/deprecated

$ref: #/definitions/experimental

$ref: #/definitions/priority

$ref: #/definitions/proximity

$ref: #/definitions/virtual

$ref: #/definitions/abstract

$ref: #/definitions/extension

$ref: #/definitions/extends

$ref: #/definitions/name-pattern-root

$ref: #/definitions/html

$ref: #/definitions/css

$ref: #/definitions/js

$ref: #/definitions/exclusive-contributions

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

$ref: #/definitions/base-contribution

$ref: #/definitions/type-list

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

$ref: #/definitions/typed-contribution

$ref: #/definitions/default

$ref: #/definitions/required

$ref: #/definitions/html-attribute-value

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.

$ref: #/definitions/type

$ref: #/definitions/type-reference

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

description: Name of the symbol to import

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

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

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

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

required: file offset

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

description: Name of the exported symbol.

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

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

description: Link to online documentation.

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.

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

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.

enum: lowest low normal high highest

$ref: #/definitions/name-pattern

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

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

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

description: HTML elements.

description: HTML attributes.

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

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)

description: Deprecated, use `elements` property.

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

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

description: CSS properties

description: CSS pseudo-elements

description: CSS pseudo-classes

description: CSS functions

description: CSS classes

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.

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.

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.

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

description: Deprecated, use top-level property.

description: Whether directive requires an argument

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.

description: Name of the library.

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

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.

title: JSON schema for Web-Types


dotnetcli.host.json

pattern: ^(true|false)$

$ref: #/definitions/symbolInfo

title: JSON schema for .NET CLI template host files


ava.json

$ref: #/definitions/path

description: Configuration Schema for the JavaScript test runner AVA

$ref: #/definitions/array-of-paths

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

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

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

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

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

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

description: Stop running further tests once a test fails

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

title: environment variables

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

description: If `true`, enables the TAP reporter

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

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

$ref: #/definitions/array-of-strings

title: extensions

enum: commonjs module

default: cjs mjs js

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

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

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

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

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

title: configuration

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

title: paths

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

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

title: AVA Config Schema


enum: running stopped

enum: never on-failure on-unhealthy always

enum: never on-create

$ref: #/definitions/createOptions

type: number string boolean

contentMediaType: application/json

title: The configuration for all the modules.

required: $edgeAgent $edgeHub

title: Configuration for the edgeAgent module

required: schemaVersion runtime systemModules modules

required: type settings

$ref: #/definitions/moduleType

required: username password address

required: edgeAgent edgeHub

$ref: #/definitions/moduleSettings

$ref: #/definitions/env

$ref: #/definitions/imagePullPolicy

title: The Edgehub Schema

required: type settings status restartPolicy

$ref: #/definitions/status

$ref: #/definitions/restartPolicy

$ref: #/definitions/startupOrder

required: type status restartPolicy settings

title: Configuration for the edgeHub module

required: schemaVersion routes

title: JSON schema for Azure IoT Edge Deployment version 2.0


ansible-lint-config.json

title: Glob-like paths to be excluded.

title: Configure how to display file paths

title: Enable List

title: Exclude Paths

title: Extra Vars

title: Kinds

title: Loop Var Prefix

title: Maximum Block Depth

title: Mock Modules

title: Mock Roles

title: Offline

title: Only Builtins Allow Collections

title: Only Builtins Allow Modules

title: Parseable

title: Profile

title: Progressive (removed feature)

title: Project Directory

title: Quiet

$ref: #/$defs/rule

enum: command-instead-of-module command-instead-of-shell deprecated-bare-vars deprecated-local-action deprecated-module empty-string-compare fqcn fqcn[action-core] fqcn[action] fqcn[canonical] fqcn[keyword] galaxy galaxy[no-changelog] galaxy[no-runtime] galaxy[tags] galaxy[version-incorrect] galaxy[version-missing] ignore-errors inline-env-var internal-error jinja jinja[invalid] jinja[spacing] key-order latest literal-compare load-failure load-failure[not-found] loop-var-prefix loop-var-prefix[missing] loop-var-prefix[wrong] meta-incorrect meta-no-tags meta-runtime meta-video-links name name[casing] name[play] name[prefix] name[template] no-changed-when no-handler no-jinja-when no-log-password no-prompting no-relative-paths no-same-owner no-tabs only-builtins package-latest parser-error partial-become playbook-extension risky-file-permissions risky-octal risky-shell-pipe role-name run-once run-once[play] run-once[task] sanity sanity[bad-ignore] sanity[cannot-ignore] schema syntax-check var-naming yaml

title: Rules specific configuration.

title: Rulesdir

title: SARIF Output filename

title: Skip Action Validation

title: Skip List

title: Strict

title: Tags

default: {stem} |

title: Allow custom prefix for task[prefix]

title: Use Default Rules

title: Regex used to verify variable names

title: Verbosity

title: Warn List

title: Write List

title: Ansible-lint Configuration Schema


$ref: #/definitions/Consumer

$ref: #/definitions/Healthy

$ref: #/definitions/Unhealthy

required: username password

$ref: #/definitions/ConsumerGroup

required: id cert key

$ref: #/definitions/ACLGroup

$ref: #/definitions/BasicAuth

$ref: #/definitions/HMACAuth

$ref: #/definitions/JWTAuth

$ref: #/definitions/KeyAuth

$ref: #/definitions/MTLSAuth


schema-project.json

title: JSON schema for Outblocks project configuration files

$ref: #/definitions/OutblocksProject

title: Outblocks

description: Project-wide DNS setup.

$ref: #/definitions/DNS

description: Project-wide state source.

$ref: #/definitions/State

description: Project-wide secrets provider.

$ref: #/definitions/Secrets

description: Project-wide dependencies to provision.

$ref: #/definitions/Dependencies

description: Project monitoring setup.

$ref: #/definitions/Monitoring

description: Project-wide plugins.

$ref: #/definitions/Plugin

description: Project-wide default app settings.

$ref: #/definitions/Defaults

title: DNS

description: SSL configuration.

$ref: #/definitions/SSL

title: SSL

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

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

description: Public key value in PEM format.

description: Private key value in PEM format.

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

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

title: State

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

title: Secrets

title: Dependencies

description: The type of the dependency.

description: Deploy config.

$ref: #/definitions/DependencyDeploy

description: Run config.

$ref: #/definitions/DependencyRun

const: storage

description: Enables versioning for objects.

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

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.

description: CORS settings.

$ref: #/definitions/DependencyStorageCORS

const: mysql

const: postgresql

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.

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

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

description: Database users.

$ref: #/definitions/DependencyDatabaseUser

title: Database user

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

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

title: Storage CORS

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

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.

title: Run

title: Deploy

title: Monitoring

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

description: Monitoring notification channels.

$ref: #/definitions/MonitoringChannel

description: Monitoring targets.

$ref: #/definitions/MonitoringTarget

title: Monitoring channels

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

enum: slack email

const: slack

description: Bot user oauth token used for slack notification.

description: Channel used for slack notification.

required: type token channel

const: email

description: Email used for email channel type.

required: type email

title: Monitoring target

description: Target full url.

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

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

title: Plugin

title: Defaults

description: Deploy config.

$ref: #/definitions/DefaultDeploy

description: DNS config.

$ref: #/definitions/DefaultDNS

description: Run config.

$ref: #/definitions/DefaultRun

title: Deploy defaults

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

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

title: DNS defaults

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

title: Run defaults

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


title: dto action

description: Enable this default header action

description: Name of the default header action

description: Expert settings for the Apache httpd.

description: Expert settings for the Security Gate.

description: Whether to ignore case.

default: true

description: Whether to invert the match.

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

$ref: #/definitions/PatternDto-nullable

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

description: The rewrite expression.

title: pattern

description: Whether to ignore case.

$ref: #/definitions/PatternWithoutInvertDto

description: A pattern for the header name.

description: A pattern for the header value.

description: A pattern for the header name.

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

description: A pattern for the header value.

description: The name of the header to add.

description: The value of the header to add.

description: The actual pattern.

title: application

title: mapping

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

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.

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

description: From which cookie the token should be extracted.

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

enum: header parameter cookie

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

default: header

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

description: How the token should be extracted.

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

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.

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

title: role

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

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

description: The claim to extract the technical client id from.

title: allowed roles

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

description: Enable the allow rule.

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

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

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

description: A pattern to match the path.

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

default: json

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.

description: The OpenAPI specification.

description: The OpenAPI file path.

description: The specification to validate against.

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.

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.

title: access restriction

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.

enum: inherit optional required

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

default: inherit

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

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

default: redirect

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

description: Expert settings for the Security Gate.

title: host

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

default: backend

description: Configuring a back-end port.

enum: https http

description: Allowed values are: http, https

default: http

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

default: backendGroup

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

$ref: #/definitions/SimplePatternDto-nullable

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

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.

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

title: exception

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%

title: denied rule groups

description: Enable deny rule group

title: exception

enum: basic standard strict

description: Allowed values are: 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: Whether a trailing slash is mandatory at the end of the entry path or not.

description: Whether to ignore case.

description: Allowed values are: directory, regex.

description: This specifies the external URL path.

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

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

description: Defines the maximum length of a parameter name in bytes.

description: Defines the maximum length for a parameter value in bytes.

description: Defines the maximum number of parameters inside the request.

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

description: The limits for HTTP parameters.

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

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

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

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

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

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

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

description: The limits for JSON structures.

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

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

description: The Airlock Gateway mapping template file path.

description: The unique name of the mapping.

description: Allowed values are: production, integration.

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.

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

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.

title: custom action

description: An action to add a header to all requests.

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

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

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

description: The http status code to use on redirect

description: The url to redirect to.

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

description: A pattern for the header name.

description: The http status code to use on redirect

description: The url to redirect to.

description: A pattern for the header value.

description: 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 unique name for this action; if not specified, a unique name will be generated.

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

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

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.

title: custom action

description: An action to add a header to all responses.

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

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

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

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

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.

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

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

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

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

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

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

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: An action to rewrite the raw value of a cookie matching the given pattern.

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

title: error page replacement

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

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

description: Rewrite the body of HTTP response.

title: rewrite

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.

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

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

title: html

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

description: The URL pattern.

description: Rewrite the json body of http responses.

title: json

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

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.

title: location header

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

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.

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

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

description: Additional hostnames which refer to this virtual host.

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

description: The file containing the selection CA certificates.

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

description: The file containing the validation CA certificates.

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.

description: The file containing the crl.

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

description: Maximum number of intermediate certificate issuers.

description: List of certificates of the CA chain for the certificate.

description: The CA chain file path.

description: The certificate in PEM format.

description: The certificate file path.

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

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

description: The hostname of the virtual host.

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

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.

description: The logical name of the virtual host.

title: redirect

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.

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]

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

title: denied rule groups

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

title: denied rules

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 that are configured statically.

title: provider

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

description: JSON Object that represents the set of JWKS.

description: JSON file with the definitions of JWKS.

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

description: Refresh interval for fetching from remote JWKS providers in seconds.

description: Remote JWKS providers which are fetched according to the jwks_providers.refresh_interval.

title: provider

description: Name of JWKS issuer. This value is used to restrict the usage of the JWKS to JWTs with a matching issuer (claim 'iss').

description: URL of JWKS service provider.

title: tls

description: The TLS cipher suite to use. For documentation visit www.openssl.org and search for 'ciphers'.

description: The CA chain file path.

description: The certificate in PEM format.

description: The certificate file path.

description: The private key file path

description: Force new session for each request.

description: The TLS protocol to use. For the description of the default values see the Gateway documentation for 'Supported SSL/TLS versions'.

description: Verification which involves a server identity check to mitigate man in the middle attacks.

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

description: The encoded license.

description: The license file path.

description: Allowed values are: info, trace

title: metrics

title: statsd

description: Enable sending of statsd metrics. Default is 'true'

description: Use this to enable sending metrics using the statsd protocol.

description: Configuration for metrics sending.

description:
If set, Airlock Microgateway will treat the value of this header field as the useragent IP address.
Common values are 'X-Forwarded-For' or 'X-Client-IP'.
Warning: Make sure that internal_proxies is correctly configured for your setup.

description: List of hostnames, IP addresses or IP address ranges (e.g. 10.0.0.0/8) to trust as presenting a valid Remote-IP header.

description: Specifies the passphrase for the passphrase based encryption mechanism (PBE).

description: The path of the passphrase file.

description: Specifies the amount of idle time in seconds, after which an Airlock Microgateway session is terminated. This timeout should be smaller than all other session timeouts of your back-end applications. Even if the timeout can be configured in seconds, per default the resolution of the idle session timeout check is 5 seconds only.

description: Specifies the absolute lifetime of an Airlock Microgateway session in seconds. After this time a session will be terminated.

description: Name of the hosts running the Redis Server.

description:
Defines the redis session store connection mode. By default, the Microgateway tries to determine the connection mode depending on the number of redis hosts configured:
- server mode if only one host is configured
- cluster mode if several hosts are configured

Allowed values are: server, cluster and disabled.


stylecop.schema.json

title: StyleCop Analyzers Configuration

description: Configuration file for StyleCop Analyzers

description: The top-level object containing configuration properties for built-in rules.

description: Indentation configuration

description: Specifies the indentation size.

description: Specifies the tab width.

description: Specifies whether indentation should use hard tabs instead of spaces.

description: Configuration for spacing rules (SA1000-)

description: Configuration for readability rules (SA1100-)

description: When true, diagnostics will not be reported for using aliases of built-in types.

description: Configuration for ordering rules (SA1200-)

description: Specifies the traits used for ordering elements within a document, along with their precedence.

default: kind accessibility constant static readonly

enum: accessibility kind constant static readonly

description: When true, System using directives should be placed before other using directives.

description:
Specifies the desired placement of using directives.
insideNamespace: Place using directives inside the namespace definition
outsideNamespace: Place using directives outside the namespace definition
preserve: Allow using directives inside or outside the namespace definition

default: insideNamespace

description:
Specifies if using groups should be separated by a blank line.
allow: A blank line is allowed, but not required
require: A blank line is required
omit: A blank line is not allowed

enum: allow require omit

default: allow

description: Configuration for naming rules (SA1300-)

description: Determines whether common Hungarian notation prefixes should be allowed.

description: Allowed Hungarian notation prefixes.

description: Allowed namespace components, such as ones beginning with a lowercase letter.

description: Specifies whether inferred tuple element names will be analyzed as well.

description: Specifies the casing convention used for tuple element names.

enum: camelCase PascalCase

default: PascalCase

description: Configuration for ordering rules (SA1400-)

description: The set of type kinds which should be placed in separate files according to the type name.

enum: class interface struct delegate enum

description: Configuration for layout rules (SA1500-)

description:
Specifies the handling for newline characters which appear at the end of a file
allow: Files are allowed to end with a single newline character, but it is not required
require: Files are required to end with a single newline character
omit: Files may not end with a newline character

description: Specifies if SA1519 will allow consecutive using statements without braces

description: Specifies if SA1500 will allow the 'while' expression of a 'do'/'while' loop to be on the same line as the closing brace.

description: Configuration for documentation rules (SA1600-)

description: Specifies whether exposed elements need to be documented. When true, all publicly-exposed types and members require documentation.

description: Specifies whether internal elements need to be documented. When true, all internally-exposed types and members require documentation.

description: Specifies whether private elements need to be documented. When true, all types and members except for declared private fields require documentation.

description: Specifies whether interface members need to be documented. When true, all interface members require documentation, regardless of accessibility.

description: Specifies whether private fields need to be documented. When true, all fields require documentation, regardless of accessibility.

description: The name of the company which appears in file headers.

default: PlaceholderCompany

description: The copyright text which should appear in file headers.

default: Copyright (c) {companyName}. All rights reserved.

description: Replacement variables which may be used in the 'copyrightText' value.

description: Determines whether the file header should be wrapped in the StyleCop-standard XML structure.

description: The text used as decoration for the copyright header comment.

description: Specifies the preferred naming convention for files. The default value "stylecop" uses the naming convention defined by StyleCop Classic, while "metadata" uses a file naming convention that matches the metadata names of types.

default: stylecop

enum: stylecop metadata

description: The culture that should be used for documentation comments.

default: en-US

description: Specifies the top-level tags within XML documentation that will be excluded from punctuation analysis.