key: selfRepository

description: Info for the plugin itself. Describes where the canonical copy of the plugin can be fetched from.


key: deprecated

description: For a deprecated plugin, a deprecation message to be shown to any user who installs the plugin.

type: string


key: otherRepository

description: Info about a plugin/repository outside this one.

type: object

type: number

enum:
color scheme
ftplugin
game
indent
syntax
utility
patch

required: type url

format: uri


description: Script ID number of the target plugin on www.vim.org, if any.


key: homepage

description: Primary homepage of the plugin.


key: name

description: The name of the plugin. Used by plugin managers and some introspection tools. Generally corresponds to the name of the repository but without "vim" prefix/suffix.

examples: surround.vim nerdtree maktaba


key: version

description: Dotted version number of the plugin, generally in semantic versioning scheme.


key: description

description: Short description of the plugin and what it does (a sentence or two)


key: author

description: Name of the person or organization that created the plugin

examples:
Priya Exampleton
Example Industries


key: maintainer

description: Name of the person who maintains the plugin


key: dependencies

description: Plugins that are strictly required for the plugin to work, where keys are plugin names and values may describe where plugins can be fetched from.


description: Configuration for GPC, so a site can convey its support for the Global Privacy Control.

type: boolean

type: integer


key: gpc

description: Indicates that the server intends to abide by GPC requests.


key: lastUpdate

description: This indicates the time at which the statement of support was made, such that later changes to the meaning of the GPC standard should not affect the interpretation of the resource for legal purposes. If the member is not in a valid ISO 8601 format, the last update date and time is unknown.


description: The graceful shutdown period for an Azure Webjob. The time specified in seconds.


description: Specify if the Webjob should be treated as a singleton. If true, the Webjob will not scale on multiple Azure Website instances like the web application itself.


description: A .appsemblerc.yaml file may be used to configure either an app or a block.

default: static

default: unlisted

enum: public unlisted private


description: The name of a block. By default the name in package.json is used.


description: A short description of the block. By default the description in package.json is used.


description: A semantic version of the block representation of the block version. By default the version in package.json is used.


key: longDescription

description: The long description of the block. Markdown is supported. By default the content of README.md is used.


key: layout

description: The type of layout to be used for the block.


key: output

description: Where to read build output from.

default: dist


key: webpack

description: The path to the webpack configuration file relative to the block project directory. By default a file named webpack.config.js is used, with a fallback to the webpack configuration from @appsemble/webpack-config.


key: events

description: An object describing the names of the events the block can listen and emit to. By default this is extracted from the block’s TypeScript module augmentations.


key: listen

description: The events the block listens on.


key: emit

description: The events the block may emit.


key: actions

description: An object which describes the actions a block can trigger. This will be used to validate app definitions. By default this is extracted from the block’s TypeScript module augmentations.


key: parameters

description: A JSON schema which describes the block parameters. By default this is extracted from the block’s TypeScript module augmentations.


key: iconBackground

description: The background color to use for maskable icons.


key: context

description: A context which can be specified using the --context command line parameter.


key: remote

description: If remote is specified, this will override --remote passed by the command line.


key: organization

description: If organization is specified, this will override --organization passed by the command line when creating an app.


key: icon

description: A path to the app icon to use


key: maskableIcon

description: A path to the maskable app icon to use


key: id

description: If id is specified, this will override --id passed by the command line when updating an app.


key: visibility

description:
Determine the app visibility of the app in the Appsemble app store.

This doesn’t affect whether or not the app can be accessed on its own domain.

- **public**: The app is publicly listed in the Appsemble app store.,
- **unlisted**: The app store page can be accessed, but the app isn’t listed publicly in the Appsemble app store.
- **private**: The app is only visible to people who are part of the organization.


key: showAppDefinition

description: Whether or not people who have access to the app may see the app definition.


key: template

description: If template is specified, this will override --template passed on the command line.


key: sentryDsn

description: A custom Sentry DSN to use for the app.


key: sentryEnvironment

description: A custom Sentry environment to use for the app.


key: logical

description:
https://circleci.com/docs/configuration-reference#logic-statements

A logical statement to be used in dynamic configuration

type: string boolean integer number

type: array


key: and

description:
https://circleci.com/docs/configuration-reference#logic-statements

Logical and: true when all statements in the list are true


key: or

description:
https://circleci.com/docs/configuration-reference#logic-statements

Logical or: true when at least one statements in the list is true


key: not

description:
https://circleci.com/docs/configuration-reference#logic-statements

Logical not: true when statement is false


key: equal

description:
https://circleci.com/docs/configuration-reference#logic-statements

True when all elements in the list are equal


key: matches

description:
https://circleci.com/docs/configuration-reference#logic-statements

True when value matches the pattern


key: filter

description: A map defining rules for execution on specific branches


key: only

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


key: ignore


key: orbs

description:
https://circleci.com/docs/configuration-reference#orbs-requires-version-21

Orbs are reusable packages of CircleCI configuration that you may share across projects, enabling you to create encapsulated, parameterized commands, jobs, and executors that can be used across multiple projects.


key: additionalProperties

description:
https://circleci.com/docs/creating-orbs#semantic-versioning-in-orbs

An orb to depend on and its semver range, or volatile for the most recent release.


description:
https://circleci.com/docs/creating-orbs#creating-inline-orbs

Inline orbs can be handy during development of an orb or as a convenience for name-spacing jobs and commands in lengthy configurations, particularly if you later intend to share the orb with others.


key: commands

description:
https://circleci.com/docs/configuration-reference#commands-requires-version-21

A command definition defines a sequence of steps as a map to be executed in a job, enabling you to reuse a single command definition across multiple jobs.

required: type enum


description:
https://circleci.com/docs/configuration-reference#commands-requires-version-21

Definition of a custom command.


key: steps

description: A sequence of steps run inside the calling job of the command.


key: parameters

description:
https://circleci.com/docs/reusing-config#using-the-parameters-declaration

A map of parameter keys.


description:
https://circleci.com/docs/reusing-config#string

A string parameter.


description:
https://circleci.com/docs/reusing-config#boolean

A boolean parameter.


description:
https://circleci.com/docs/reusing-config#integer

An integer parameter.


description:
https://circleci.com/docs/reusing-config#enum

The `enum` parameter may be a list of any values. Use the `enum` parameter type when you want to enforce that the value must be one from a specific set of string values.


description:
https://circleci.com/docs/reusing-config#executor

Use an `executor` parameter type to allow the invoker of a job to decide what executor it will run on.


description:
https://circleci.com/docs/reusing-config#steps

Steps are used when you have a job or command that needs to mix predefined and user-defined steps. When passed in to a command or job invocation, the steps passed as parameters are always defined as a sequence, even if only one step is provided.


description:
https://circleci.com/docs/reusing-config#environment-variable-name

The environment variable name parameter is a string that must match a POSIX_NAME regexp (e.g. no spaces or special characters) and is a more meaningful parameter type that enables additional checks to be performed.


key: description

description: A string that describes the purpose of the command.


key: dockerExecutor

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

type: string number boolean


key: image

description: The name of a custom docker image to use


key: name

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


key: entrypoint

description: The command used as executable when launching the container


key: command

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


key: user

description: Which user to run the command as


key: environment

description: A map of environment variable names and values


key: auth

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


description: Authentication for AWS EC2 Container Registry (ECR)


key: machineExecutor

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

default: true


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


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


key: macosExecutor

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


key: xcode

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


key: machine

description: Use the default machine executor image


key: executors

description: Executors define the environment in which the steps of a job will be run, allowing you to reuse a single executor definition across multiple jobs.

default: medium

type: string number


description: Amount of CPU and RAM allocated to each container in a job. Note: A performance plan is required to access this feature.


key: shell

description: Shell to use for execution command in all steps. Can be overridden by shell in each step (default: See [Default Shell Options](https://circleci.com/docs/configuration-reference#default-shell-options)


description: In which directory to run the steps.


description: A map of environment variable names and values.


key: run

description:
https://circleci.com/docs/configuration-reference#run

Used for invoking all command-line programs, taking either a map of configuration values, or, when called in its short-form, a string that will be used as both the `command` and `name`. Run commands are executed using non-login shells by default, so you must explicitly source any dotfiles as part of the command.


key: checkout

description:
https://circleci.com/docs/configuration-reference#checkout

Special step used to check out source code to the configured `path` (defaults to the `working_directory`). The reason this is a special step is because it is more of a helper function designed to make checking out code easy for you. If you require doing git over HTTPS you should not use this step as it configures git to checkout over ssh.


https://circleci.com/docs/configuration-reference#setup_remote_docker

Creates a remote Docker environment configured to execute Docker commands.


https://circleci.com/docs/configuration-reference#save_cache

Generates and stores a cache of a file or directory of files such as dependencies or source code in our object storage. Later jobs can restore this cache using the `restore_cache` step.


https://circleci.com/docs/configuration-reference#restore_cache

Restores a previously saved cache based on a `key`. Cache needs to have been saved first for this key using the `save_cache` step.


key: deploy

description:
https://circleci.com/docs/configuration-reference#deploy

Special step for deploying artifacts. `deploy` uses the same configuration map and semantics as run step. Jobs may have more than one deploy step. In general deploy step behaves just like run with two exceptions:
* In a job with parallelism, the deploy step will only be executed by node #0 and only if all nodes succeed. Nodes other than #0 will skip this step.
* In a job that runs with SSH, the deploy step will not execute


https://circleci.com/docs/configuration-reference#store_artifacts

Step to store artifacts (for example logs, binaries, etc) to be available in the web app or through the API.


https://circleci.com/docs/configuration-reference#storetestresults

Special step used to upload test results so they display in builds' Test Summary section and can be used for timing analysis. To also see test result as build artifacts, please use the `store_artifacts` step.


https://circleci.com/docs/configuration-reference#persist_to_workspace

Special step used to persist a temporary file to be used by another job in the workflow


https://circleci.com/docs/configuration-reference#attach_workspace

Special step used to attach the workflow's workspace to the current container. The full contents of the workspace are downloaded and copied into the directory the workspace is being attached at.


https://circleci.com/docs/configuration-reference#add_ssh_keys

Special step that adds SSH keys from a project's settings to a container. Also configures SSH to use these keys.


key: when

description:
https://circleci.com/docs/configuration-reference#the-when-step-requires-version-21

Conditional step to run on custom conditions (determined at config-compile time) that are checked before a workflow runs


key: unless

description:
https://circleci.com/docs/configuration-reference#the-when-step-requires-version-21

Conditional step to run when custom conditions aren't met (determined at config-compile time) that are checked before a workflow runs


description: Command to run via the shell


key: name

description: Title of the step to be shown in the CircleCI UI (default: full `command`)


description: Shell to use for execution command


description: Additional environmental variables, locally scoped to command


key: background

description: Whether or not this step should run in the background (default: false)


description: In which directory to run this step (default: `working_directory` of the job


description: Elapsed time the command can run without output. The string is a decimal with unit suffix, such as "20m", "1.25h", "5s" (default: 10 minutes)


description: Specify when to enable or disable the step. Takes the following values: `always`, `on_success`, `on_fail` (default: `on_success`)


description: Title of the step to be shown in the CircleCI UI


key: path

description: Checkout directory (default: job's `working_directory`)


description: When `docker_layer_caching` is set to `true`, CircleCI will try to reuse Docker Images (layers) built during a previous job or workflow (Paid feature)


key: version

description: If your build requires a specific docker image, you can set it as an image attribute


key: paths

description: List of directories which should be added to the cache


key: key

description: Unique identifier for this cache


description: Title of the step to be shown in the CircleCI UI (default: 'Saving Cache')


description: Single cache key to restore


description: Title of the step to be shown in the CircleCI UI (default: 'Restoring Cache')


key: keys

description: List of cache keys to lookup for a cache to restore. Only first existing key will be restored.


description: Directory in the primary container to save as job artifacts


key: destination

description: Prefix added to the artifact paths in the artifacts API (default: the directory of the file specified in `path`)


description: Path (absolute, or relative to your `working_directory`) to directory containing subdirectories of JUnit XML or Cucumber JSON test metadata files


key: root

description: Either an absolute path or a path relative to `working_directory`


description: Glob identifying file(s), or a non-glob path to a directory to add to the shared workspace. Interpreted as relative to the workspace root. Must not be the workspace root itself.


key: at

description: Directory to attach the workspace to


key: fingerprints

description: Directory to attach the workspace to


key: steps

description: A list of steps to be performed


key: step

description:
https://circleci.com/docs/reusing-config#invoking-reusable-commands

A custom command defined via the top level commands key


description:
https://circleci.com/docs/using-orbs#commands

A custom command defined via an orb.


key: jobRef

description: Run a job as part of this workflow

default: org-global


key: requires

description: Jobs are run in parallel by default, so you must explicitly require any dependencies by their job name.


description: The name key can be used to ensure build numbers are not appended when invoking the same job multiple times (e.g., sayhello-1, sayhello-2). The name assigned needs to be unique, otherwise numbers will still be appended to the job name


key: context

description: Either a single context name, or a list of contexts. The default name is `org-global`


key: type

description: A job may have a `type` of `approval` indicating it must be manually approved before downstream jobs may proceed.


key: filters

description: A map defining rules for execution on specific branches


key: matrix

description:
https://circleci.com/docs/configuration-reference#matrix-requires-version-21

The matrix stanza allows you to run a parameterized job multiple times with different arguments.


key: parameters

description: A map of parameter names to every value the job should be called with


key: exclude

description: A list of argument maps that should be excluded from the matrix


key: alias

description: An alias for the matrix, usable from another job's requires stanza. Defaults to the name of the job being executed


key: jobs

description: Jobs are collections of steps. All of the steps in the job are executed in a single unit, either within a fresh container or VM.

default: ~/project


key: executor

description: The name of the executor to use (defined via the top level executors map).


description: Executor stanza to use for the job


key: name


key: shell

description: Shell to use for execution command in all steps. Can be overridden by shell in each step


description: A list of steps to be performed


description: In which directory to run the steps. (default: `~/project`. `project` is a literal string, not the name of the project.) You can also refer the directory with `$CIRCLE_WORKING_DIRECTORY` environment variable.


key: parallelism

description: Number of parallel instances of this job to run (default: 1)


key: environment

description: A map of environment variable names and variables (NOTE: these will override any environment variables you set in the CircleCI web interface).


key: branches

description: A map defining rules for whitelisting/blacklisting execution of specific branches for a single job that is **not** in a workflow (default: all whitelisted). See Workflows for configuring branch execution for jobs in a workflow.


key: version

description: The version field is intended to be used in order to issue warnings for deprecation or breaking changes.


key: workflows

description: Used for orchestrating all jobs. Each workflow consists of the workflow name as a key and a map as a value


description: The Workflows `version` field is used to issue warnings for deprecation or breaking changes during v2 Beta. It is deprecated as of CircleCI v2.1


key: triggers

description: Specifies which triggers will cause this workflow to be executed. Default behavior is to trigger the workflow when pushing to a branch.


key: schedule

description: A workflow may have a schedule indicating it runs at a certain time, for example a nightly build that runs every day at 12am UTC:


key: cron

description: See the [crontab man page](http://pubs.opengroup.org/onlinepubs/7908799/xcu/crontab.html)


key: filters

description: A map defining rules for execution on specific branches


key: when

description: Specify when to run the workflow.


key: unless

description: Specify when *not* to run the workflow.


key: items

description:
A path pattern
https://clangd.llvm.org/config.html#if


description:
A flag
https://clangd.llvm.org/config.html#compileflags


description:
A diagnostic
https://clangd.llvm.org/config.html#clangtidy


key: If

description:
Conditions
https://clangd.llvm.org/config.html#if


key: PathMatch

description:
Path patterns
https://clangd.llvm.org/config.html#pathmatch


key: PathExclude

description:
An exclude path pattern
https://clangd.llvm.org/config.html#pathexclude


key: CompileFlags

description:
Flag lists to be added or removed
https://clangd.llvm.org/config.html#compileflags

examples: -xc++ -Wall


key: Add

description:
Flags to be added to the compile command
https://clangd.llvm.org/config.html#add


key: Remove

description:
Flags to be removed from the compile command
https://clangd.llvm.org/config.html#remove


key: CompilationDatabase

description:
A directory to search for compilation database
https://clangd.llvm.org/config.html#compilationdatabase


key: Compiler

description:
An `argv[0]` replacement
https://clangd.llvm.org/config.html#compiler


key: Index

description: Code interpretation outside of the current file

enum: Build Skip

default: Build

pattern: [nN][oO][nN][eE]

enum: Yes No


key: Background

description:
Whether to produce a project index from files built in the background
https://clangd.llvm.org/config.html#background


key: External

description:
An external index source
https://clangd.llvm.org/config.html#external


key: File

description:
A file
https://clangd.llvm.org/config.html#external


key: Server

description:
A server
https://clangd.llvm.org/config.html#external


key: MountPoint

description:
A mount point
https://clangd.llvm.org/config.html#external


key: StandardLibrary

description:
Whether to index a standard library
https://clangd.llvm.org/config.html#standardlibrary


key: Style

description:
A code base style
https://clangd.llvm.org/config.html#style


key: FullyQualifiedNamespaces

description:
List of fully qualified namespaces
https://clangd.llvm.org/config.html#fullyqualifiednamespaces


key: Diagnostics

description:
Diagnostics
https://clangd.llvm.org/config.html#diagnostics

readability-identifier-naming.VariableCase: CamelCase


key: Suppress

description:
Diagnostic codes that to be suppressed
https://clangd.llvm.org/config.html#suppress


key: items

description:
A diagnostic code that to be suppressed
https://clangd.llvm.org/config.html#suppress


key: ClangTidy

description:
Clang-Tidy options
https://clangd.llvm.org/config.html#clangtidy


key: Add

description:
Checks to enable
https://clangd.llvm.org/config.html#add-1


key: Remove

description:
Checks to disable
https://clangd.llvm.org/config.html#remove-1


key: CheckOptions

description:
Check's options
https://clangd.llvm.org/config.html#checkoptions


key: UnusedIncludes

description:
Whether to enable Include Cleaner's unused includes diagnostics
https://clangd.llvm.org/config.html#unusedincludes


key: Completion

description:
Completion options
https://clangd.llvm.org/config.html#completion


key: AllScopes

description:
Whether to include suggestions from scopes that are not visible
https://clangd.llvm.org/config.html#allscopes


key: InlayHints

description:
Inlay-hints options
https://clangd.llvm.org/config.html#inlayhints


key: Enabled

description:
Whether to enable inlay-hints
https://clangd.llvm.org/config.html#enabled


key: ParameterNames

description:
Whether to enable inlay-hints for parameter names in function calls
https://clangd.llvm.org/config.html#parameternames


key: DeducedTypes

description:
Whether to enable inlay-hints for deduced types
https://clangd.llvm.org/config.html#deducedtypes


key: Designators

description:
Whether to enable inlay-hints for designators in aggregate initialization
https://clangd.llvm.org/config.html#designators


key: Hover

description:
Hover card's options
https://clangd.llvm.org/config.html#hover


key: ShowAKA

description:
Whether to display desugared types
https://clangd.llvm.org/config.html#showaka


description: Schema for a dprint configuration file.

const: auto

const: crlf

const: lf

const: system


key: $schema

description: The JSON schema reference. Normally you shouldn't bother to provide this as the dprint vscode editor extension will handle constructing the schema for you based on the plugins provided.


key: incremental

description: Whether to format files only when they change.


key: extends

description: Configurations to extend.


description: A file path or url to a configuration file to extend.


description: A collection of file paths and/or urls to configuration files to extend.


key: lineWidth

description: The width of a line the printer will try to stay under. Note that the printer may exceed this width in certain cases.


key: indentWidth

description: The number of characters for an indent.


key: useTabs

description: Whether to use tabs (true) or spaces (false) for indentation.


key: newLineKind

description: The kind of newline to use.


description: For each file, uses the newline kind found at the end of the last line.


description: Uses carriage return, line feed.


description: Uses line feed.


description: Uses the system standard (ex. crlf on Windows).


key: includes

description: Array of patterns (globs) to use to find files to format.


key: excludes

description: Array of patterns (globs) to exclude files or directories to format.


key: plugins

description: Array of plugin URLs to format files.


key: additionalProperties

description: Plugin configuration.


key: primaryContact

description: Contact details for the owner of the asset, i.e. the Product Owner.These details will be used when customers make enquiries or request access to the asset through the portal.

Jo Doe

role: PO


key: emailAddress

description: must end with `gov.uk`


description: Allows you to provide paths to technical documentation to be published to the portal.


description: Path to the technical documentation, relative to the current working directory.


key: filters

description: A list of filtering options to improve searchability on the portal. Please check the README file to check the valid combinations of `lifecycle`, `profile`, and `access`.

required: asset_type owner categories visibility lifecycle profile access

enum:
In Development
Pre-Prod
Prod

enum: Strategic Transitional

enum: Open Closed

enum: Deprecated Removed

const: Legacy

const: Closed

enum:
REST API
SOAP API
Event
Datasets

enum:
AME Payments
Citizen Income
Citizen Information
Document Repository Services
Integration
Legacy Bridge
Notifications Platform
Personal Independence Payment
Reference Data Service
Retirement, Bereavement & Care
Common Capabilities
Other

enum:
Address
Awards
Citizen
Data
Document Services
Financial
GUID
SMS
Other

enum: Internal Public

enum:
In Development
Pre-Prod
Prod
Deprecated
Removed

enum: Strategic Transitional Legacy

asset_type: REST API

owner: Integration

visibility: Internal

lifecycle: Prod

profile: Transitional

access: Open


key: searchTags

description: Tags to label the asset in order to increase discoverability. Minimum of 3 in CSV format.


key: relatedAssets

description: A list of other assets that are related to the asset being published. Must match the Asset ID on the related asset's business documentation page on the portal at https://gitlab.com/dwp/integration/api-exchange/exchange-content/-/tree/main/output/dwp/portal/workspaces/primary/content/_catalogueEntries.


key: examples

description: This is an example service

lifecycle: Pre-Prod

access: Closed


key: host

description: The name of the host that should activate the service.


key: hostId

description: A non-empty value will cause this service to be activated on a dedicated host with this ID. All services with the same host / hostId combination will run in the same host process such that they may share global data. If unspecified or empty, a service will share its host process with other services that require the same host and also leave this field empty. If specified, the value must not have spaces in it.


key: hostGroupAllowed

description: A value of 'true' will allow a client to specify a host group when requesting this service.


key: entryPoint

description: Host-specific parameters that describe how to activate this service.

required: assemblyPath fullClassName

required: scriptPath constructorFunction


key: assemblyPath

description: The path to the assembly that carries the service entrypoint class, relative to this file.


key: fullClassName

description: The full name of the class to instantiate (that accepts a Stream in its constructor) when a new client requests this service.


key: appBasePath

description: The path that the AppDomain hosting the service should be configured to consider the ApplicationBase, relative to this file.


key: configPath

description: The config file used to initialize the service's AppDomain. It may be omitted if the config file has the same name (+.config) as the service assembly, and resides in the same directory. It is also possible to have the service without the config file.


key: scriptPath

description: The path to the .js file to 'require', relative to this file.


key: constructorFunction

description: The name of the constructor function to use (that accepts a stream) when a new client requests this service.


key: versionRange

description: Defines the version of the service.


key: onsuccess

description: If node is successful and onsuccess equals next_stage, event is moved to the next stage


key: debug

description: If true, enables the debug. Default is false.


key: nodes

description:
nodes is a list of parser nodes, allowing you to build
trees. Each subnode must be valid, and if any of the subnodes
succeed, the whole node is considered successful.


key: description

description: description of the parser usage


key: format

description:
Non mandatory format version for the parser. configuration
file. New features, may not be understood by old crowdsec
version, filling this correctly ensures that crowdsec supports
all the required parser features.


key: name

description:
The mandatory name of the node. If not present, node will be
skipped at runtime. It is used for example in debug log to help
you track things.


key: filter

description:
filter must be a valid expr expression that will be evaluated
against the event.  If filter evaluation returns true or is
absent, node will be processed.  If filter returns false or a
non-boolean, node won't be processed.


key: grok

description:
A valid grok pattern can be set up using the "pattern" field, or
a named grok used through the name "field". This applies either
on an valid expr "expression" or on directly on a field
"apply_on"


key: data

description:
data allows user to specify an external source of data. This
section is only relevant when cscli is used to install parser
from hub, as it will download the source_url and store it to
dest_file. When the parser is not installed from the hub,
CrowdSec won't download the URL, but the file must exist for the
parser to be loaded correctly.

pattern: ^(string|regexp)$

pattern: ^(LRU|LFU|ARC)$


key: ttl

description: Duration after which cache elements expire


key: size

description: Maximum size of the cache


key: type

description:
The type is mandatory if you want to evaluate the data in
the file, and should be regex for valid (re2) regular
expression per line or string for string per line. The
regexps will be compiled, the strings will be loaded into
a list and both will be kept in memory. Without specifying
a type, the file will be downloaded and stored as file and
not in memory.


description: destination to store the downloaded file to


key: strategy

description: Strategy for cache behavior. See https://pkg.go.dev/github.com/bluele/gcache


description: url to download file from


description:
pattern_syntax allows user to define named capture group
expressions for future use in grok patterns. Regexp must be a
valid RE2 expression.


key: stash

description:
The stash section allows a parser to capture data, that can be
later accessed/populated via GetFromStash and SetInStash expr
helpers. Each list item defines a capture directive that is
stored in a separate cache (string:string), with its own maximum
size, eviction rules etc.

required: name key value

pattern: ^(LFU|LRU|ARC)$


description: The caching strategy to be used : LFU, LRU or ARC (see gcache doc for details). Defaults to LRU.


key: key

description: The expression that defines the string that will be used as a key.


description: The name of the stash. Distinct parsers can manipulate the same cache


key: value


description: The time to leave of items. Default strategy is LRU.


description: The maximum size of the cache.


key: statics

description:
Statics is a list of directives that will be evaluated when the
node is considered successful. Each entry of the list is
composed of a target (where to write) and a source (what data to
write).


description: Serenity code generator (sergen) configuration

required: Tablename Identifier Module PermissionKey

enum: LF CRLF

enum: None All NameOnly

enum: Community Premium


key: Tablename

description: Table name


key: Identifier

description: Row identifier without Row suffix


key: Module

description: Module name


key: PermissionKey

description: Permission key


key: Key

description: Key of connection


key: ConnectionString

description: Connection string


key: ProviderName

description: Provider name


key: Dialect

description: Dialect


key: Tables

description: Generated table information


key: Extends

description:
If specified, the settings in this file extends settings in a base file similar to tsconfig.json
You can also use Sergen defaults by specifying this like "defaults@x.y.z"


key: RootNamespace

description: The root namespace for the target project. It is recommended to have this in sergen.json. If not there, it will be auto calculated from root namespace in CSPROJ file, or derived from project file name by removing .Web suffix. Generated code will be placed under this namespace and project's own types are assumed to be under this namespace as well


key: DeclareJoinConstants

description: If true, generated code will declare and use jFKTable type of constants for expressions in entities


key: EnableRowTemplates

description: If true, enables RowTemplate class generation. This should only be used when Serenity.Pro.Coder is enabled in the project


key: EndOfLine

description: End of line character to use in generated files. If not specified, it will be auto detected from the environment


key: FileScopedNamespaces

description: If true, generated code will use file scoped namespaces


key: ParseGlobalUsings

description: If true, generated code will parse global usings from the current project


key: IncludeGlobalUsings

description: If specified, generated code will assume these usings are in global using scope


key: ExcludeGlobalUsings

description: If specified, generated code will assume these usings are not in global using scope even if they are in global using scope


key: OmitDefaultSchema

description: If true, the default schema name, e.g. "dbo" for SQL Server won't be emitted in generated field expressions in Row.cs files. This is true by default only for MySql as in MySql schema names are actually database names


key: UseOriginAttribute

description: If true, instead of using [Expression] attributes for foreign view fields, it will use Origin(nameof(jFK), nameof(FKRow.ViewField)) if the FKRow is already generated in the project. It will also use ForeignKey(typeof(FKRow)) type of foreign keys instead of strings


key: SaveGeneratedTables

description: If true, generated table options like Identity, Module etc. will be saved to the Connections array in sergen.json after code generation. Default is true


key: ClientTypes

description: Client types code generation related configuration


key: OutDir

description: The output directory for generated client types .cs files


key: SourceGenerator

description: If false, the client types source generator in Serenity.Pro.Coder will be disabled


key: MVC

description: MVC (e.g. view locations) related configuration


key: UseRootNamespace

description: If true, generated MVC views will be placed under the root namespace of the project


description: The output directory for MVC.cs


key: SearchViewPaths

description: View paths to search for, defaults to "Modules" and "Views". "ProjectName" is used instead of "Modules" if Razor SDK is used  for the project, e.g. a Razor class library


key: StripViewPaths

description: Strip view paths from generated files. Defaults to "Modules", "Views". E.g. a subclass for Modules and Views won't be generated


description: If false, the view paths source generator in Serenity.Pro.Coder will be disabled


key: ServerTypings

description: Server typings code generation related configuration


key: Assemblies

description: Assemblies for server typings generation. Specify only if Sergen can't auto determine your project output file


description: The output directory for generated server typings files


key: LocalTexts

description: If true, local texts will be generated


key: ModuleReExports

description: If true, module re-exports will be generated. Defaults to true


key: ModuleTypings

description: If true, module typings will be generated. Defaults to true if you have "module" defined in tsconfig.json


key: NamespaceTypings

description: If true, namespace typings will be generated. Defaults to true if you don't have "module" defined in tsconfig.json


description: If false, the server typings source generator in Serenity.Pro.Coder will be disabled


key: Restore

description: Sergen restore command related configuration


key: Include

description: List of files (git ignore like) to include while restoring


key: Exclude

description: List of files (git ignore like) to exclude while restoring


key: Typings

description: Set false to disable namespace typings restore to typings/ folder


key: EntryPoints

description: List of entry point globs, default is "**/Page.ts", "**/ScriptInit.ts"


description: Should the list of entry points, e.g. ESM be generated, only available with Serenity.Pro.Coder


key: Connections

description: List of connections. It is only needed when it is desired to work / generated code based on a connection string that is not in appsettings.json


description: Path to KDiff3 executable. If not specified, it will be auto detected from the environment. (deprecated)


key: TSCPath

description: Full path to TypeScript compiler. It is assumed to be in path if not specified


key: ClassName

description: The base class name


key: Fields

description: The base class fields that should exists in a table for this base class to be used


key: ForeignFieldSelection

description: The set of foreign fields to generate, default is NameOnly


key: IncludeForeignFields

description: A list of foreign fields to include in generated code. This could be used to include some additional fields This could be used to include some additional fields. Not so useful if ForeignFieldSelection is All


key: RemoveForeignFields

description: A list of foreign fields to omit from generated code. This could be used to disable generating code for join fields like CreatedBy, ModifiedBy etc, so properties like CustomerCreatedBy, CustomerModifiedBy etc. won't be generated in OrderRow. Not so useful if ForeignFieldSelection is None or NameOnly


key: CustomTemplates

description:
The location of custom templates folder. The files in this folder will override the default scriban templates in Sergen. You may also include additional files to be generated. Their names must match the names at
https://github.com/serenity-is/Serenity/tree/master/src/Serenity.Net.CodeGenerator/Templates


key: CustomGenerate

description: The relative paths of custom generated files


key: CustomSettings

description: Custom settings to be passed to and used in custom templates


key: AppSettingFiles

description: The list of appsettings.json files in order. Default is appsettings.json, appsettings.machine.json


key: UpgradeInfo

description: The upgrade / migration related information used by stargen to determine the base version of template used, and already applied upgrades


key: InitialType

description: Initial type of project. Available options are "Community" e.g. Serene, "Premium" e.g. StartSharp


key: InitialVersion

description: Version this project is created from. Used to determine which migrations should be applied to project (starting from)


key: AppliedUpgrades

description: List of already applied upgrades if any


description: A schema for config of dein.vim (https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L963)

default: vim

enum: indent plugin colors ftplugin

enum: none raw git

enumValues: Raw plugin file ('script_type' attribute is needed)

pattern: ^[nvxsomilct]+$


key: repo

description: The repository URI or local repository directory path.


key: augroup

description: An augroup name that the plugin uses for |VimEnter| or |GUIEnter| autocmd events.


key: build

description: Specify the build script. This command is executed by |system()| in the plugin runtimepath. Note: In previous versions of dein, build could also be of type dictionary, but that is now deprecated. Please use |dein-options-hook_post_update| instead.


key: depends

description: Specify a list of plugins a plugin depends on. List items are '{plugin-name}'. Those specified in the list are NOT installed automatically. Note: The loading order is not guaranteed in non lazy plugins.


key: frozen

description: If set to v:true, dein doesn't update it automatically. It is useful for outdated plugins that can no longer be updated.


key: ftplugin

description: '_' key is executed after all ftplugin. '{filetype}' key is executed {filetype} ftplugin.


description: '_' key is executed after all ftplugin.


description:
'{filetype}' key is executed {filetype} ftplugin.
You can define multiple filetypes by '{filetype1}_{filetype2}' key.
'b:undo_ftplugin' is defined automatically.


key: if

description: If set to v:false, dein doesn't register the plugin, i.e. the plugin will be disabled. If it is String, dein will eval it. If you don't set it, dein will register (enable) the plugin


key: lazy

description: If set to v:true, dein doesn't add the path to 'runtimepath' automatically. If you don't set it, dein will set it automatically when the conditions are met. Note: You should not specify the plugins which have no 'plugin/' directory as lazy load plugins.  It is meaningless and just increases the overhead.  You can get the no meaning lazy plugins by |dein#check_lazy_plugins()|.


key: merged

description: If set to v:false, dein doesn't merge the plugin directory. It is useful for the plugin files conflicts.


If set to v:true, dein merge the plugin "ftdetect" directory. It is useful to enable file detection when lazy loaded plugin. Note: It does not work if ftdetect script depends on lazy plugin functions.


key: name

description: Specify the name of the plugin. This is used for dein management and other functions. If it is omitted, the tail of the repository name will be used. Note: Must be unique across the all plugin. If the plugin name conflicts with another plugin, dein will overwrite the previous settings with the new one. If the repo tail is bound to conflict, you can set the 'name' option manually to prevent overwriting an existing plugin setting.


description: Specify the normalized name of the plugin.  If omitted, dein will normalize the tail of the repository name. Note: Must be unique across all plugins.


If it is matched to the executed command, dein will call |dein#source()|.


dein will call |dein#source()| on the events.


If it is matched to the called function, dein will call |dein#source()|.


If it is matched to 'filetype', dein will call |dein#source()|.


description: If it is evaluated and it is non-zero, dein will call|dein#source()|.The default evaluate timings are 'BufRead', 'BufNewFile','VimEnter' and 'FileType'.If |dein-options-on_event| exists, it is evaluated when|dein-options-on_event|.


If it is matched to the required lua module root, dein will call |dein#source()|. Note: It is for neovim only. Note: It does not work for neovim standard modules.


If it is the Dictionary, the key is {mode} and the items are{mapping} or [{mapping1}, {mapping2}, ...].If it is the List, the items are {mapping} or [{mode},{mapping1}, [{mapping2}, ...]].If {mode} is omitted, 'nx' is used.


If set to '.*', dein will call |dein#source()| on editing allfiles.  Otherwise, dein will call |dein#source()| if thebuffer name is matched to the string pattern.Note: It is useful for explorer behavior plugins.


key: overwrite

description: If set to v:true, dein overwrite existing plugin config when |dein#add()|.


key: path

description: Specify the plugin downloaded path.


key: rev

description: Specify a revision number or branch/tag name. If it is '*' in 'git' type, dein will use latest released tag.You can specify the wildcards like '0.*'.Note: If the type is 'raw', rev must be hash number.


key: rtp

description: Specify the runtime path. You can use it when the repository has the Vim plugin in a subdirectory.For example: https://github.com/rstacruz/sparkup If it is empty string, dein will not add the path to'runtimepath'


description: Specify the script type. It is useful for non-official categorized plugins. For example: 'indent', 'plugin', 'ftplugin', ... Note: You must not specify it for categorized plugins.


key: timeout

description: The time of timeout seconds when updating/installing plugins. If omit it, |g:dein#install_process_timeout| will be used.


key: trusted

description: If set to v:true, dein will load the plugin in 'sudo' mode. If you don't set it, dein won't load it.


key: type

description: Specify the repository type. If it is omitted, a guess is made based on {repository}.


description:
The history depth for 'git clone'.
 If omitted, |g:dein#types#git#clone_depth| is used. If it is than 0, dein clones the repository by shallow clone. Shallow clone feature saves your repository clone time. But it has problems in some repository.
 Note: This attribute is available in git type only.

 https://github.com/Shougo/neobundle.vim/issues/81 https://github.com/Homebrew/homebrew/issues/12024


description: It is executed after the line is parsed. Note: You cannot call plugin function in 'hook_add'. Because the plugin is not sourced when 'hook_add'.


description: It is executed after the all plugins are updated.


description: It is executed after plugins are sourced.  Note: In Vim initializing, you must call the 'hook_post_source' hooks manually in |VimEnter| if needed.


description: It is executed after the plugins are updated.


description: It is executed before plugins are sourced. Note: The 'sourced' means after |dein#end()| or when |VimEnter| or autoloaded.           'type': 'string',


description:
Lua lauguage string hook instead of Vim script.
It is converted to "hook_add" key.


description:
Lua lauguage string hook instead of Vim script.
It is converted to "hook_source" key.


key: plugins

description: The repository URI or local repository directory path.


key: repo-string-pattern

description: If {repo} starts with github user name (ex:'Shougo/dein.vim'), dein will install github plugins.


key: ^[nvxsomilct]+$

description: Pattern for vim key binding. You can use plugin prefix mappings. You can use '<Plug>' keyword as {mapping}. If{mapping} is '<Plug>', '<Plug>(normalized_name' isused. linter support is now under developping


description:
Definition properties table for installing a vim plugin.
It is converted to |dein#add()|.


description:
'_' key is executed after all ftplugin.
'{filetype}' key is executed {filetype} ftplugin.
 You can define multiple filetypes by '{filetype1}_{filetype2}' key.


description: '_' key is executed after all ftplugin.


description:
'{filetype}' key is executed {filetype} ftplugin.
You can define multiple filetypes by '{filetype1}_{filetype2}' key.
'b:undo_ftplugin' is defined automatically.


description:
It is the global |dein-options-hook_add|.
It is executed in |dein#end()|.


description:
It is converted to |dein-toml-hook_add|
"plugins" key is needed.


key: id

description: id of the hook - used in pre-commit-config.yaml.


description: name of the hook - shown during hook execution.


key: entry

description: entry point - the executable to run. Can also contain arguments that will not be overridden such as `entry: autopep8 -i`.


key: language

description: language of the hook - tells pre-commit how to install the hook.


key: alias

description: (optional) allows the hook to be referenced using an additional id.


key: files

description: (optional) the pattern of files to run on.


key: exclude

description: (optional) exclude files that were matched by files.


key: types

description: (optional) list of file types to run on (AND).


(optional) list of file types to run on (OR).


(optional) pattern of files to exclude.


description: (optional) a list of dependencies that will be installed in the environment where this hook gets run. One useful application is to install plugins for hooks such as eslint.


description: (optional) if true this hook will run even if there are no matching files.


key: verbose

description: (optional) if true, forces the output of the hook to be printed even when the hook passes.


description: (optional) if false no filenames will be passed to the hook.


description: (optional) if true this hook will execute using a single process instead of in parallel.


key: description

description: (optional) description of the hook. Used for metadata purposes only.


description: (optional) see Overriding language version at https://pre-commit.com/#overriding-language-version

default: default


description: (optional) if present, the hook output will additionally be written to a file.


description: (optional) allows one to indicate a minimum compatible pre-commit version.


key: args

description: (optional) list of additional parameters to pass to the hook.


key: stages

description: (optional) confines the hook to the commit, merge-commit, push, prepare-commit-msg, commit-msg, post-checkout, post-commit, post-merge, post-rewrite, or manual stage. See Confining hooks to run at certain stages in https://pre-commit.com/#confining-hooks-to-run-at-certain-stages


key: SPDXLicenseEnum

description: An enumeration.


description: Schema for codecov.yml files.

default: auto

type: array string

enum: failure success

default: success

enum: error success

enum: include exclude pass

type: boolean array

enum: header footer diff file files flag flags reach sunburst uncovered

enum: parent pr auto

type: string integer boolean

enum: down up nearest


key: codecov

description: See https://docs.codecov.io/docs/codecov-yaml for details


key: bot

description: Team bot. See https://docs.codecov.io/docs/team-bot for details


key: ci

description: Detecting CI services. See https://docs.codecov.io/docs/detecting-ci-services for details.


key: coverage

description: Coverage configuration. See https://docs.codecov.io/docs/coverage-configuration for details.

type: boolean object

type: object boolean


key: notify

description: Notifications. See https://docs.codecov.io/docs/notifications for details.


key: slack

description: Slack. See https://docs.codecov.io/docs/notifications#section-slack for details.


key: gitter

description: Gitter. See https://docs.codecov.io/docs/notifications#section-gitter for details.


key: hipchat

description: Hipchat. See https://docs.codecov.io/docs/notifications#section-hipchat for details.


key: status

description: Commit status. See https://docs.codecov.io/docs/commit-status for details.


key: ignore

description: Ignoring paths. see https://docs.codecov.io/docs/ignoring-paths for details.


key: fixes

description: Fixing paths. See https://docs.codecov.io/docs/fixing-paths for details.


key: flags

description: Flags. See https://docs.codecov.io/docs/flags for details.


key: comment

description: Pull request comments. See https://docs.codecov.io/docs/pull-request-comments for details.

enum: default once new spammy


description: GitHub Checks. See https://docs.codecov.com/docs/github-checks for details.


description: Schema for bundleconfig.json files

required: outputFile inputFile


key: includeInProject

description: Set to true to include the output file in the project. Doesn't work in some Visual Studio project types like ASP.NET 5 applications.


key: inputFile

description: One or more relative file names to bundle.


key: minify

description: Specify options for minification of the output file.


key: outputFile

description: The relative path to the desired output file name.


key: sourceMap

description: DEPRECATED! Use 'options/sourceMap' instead.


key: webOptimizer

description: Settings for WebOptimizer.Core


key: enableCaching

description: Determines if the "cache-control" HTTP headers should be set and if conditional GET (304) requests should be supported. This could be helpful to disable while in development mode.


key: enableTagHelperBundling

description: Determines if `<script>` and `<link>` elements should point to the bundled path or a reference per source file should be created. This is helpful to disable when in development mode.


key: cdn

description: Definitions for WebEssentials.AspNetCore.CdnTagHelpers


key: url

description: An absolute URL used as a prefix for static resources


key: prefetch

description: If true, injects a <link rel='dns-prefetch'> tag that speeds up DNS resolution to the CDN.


key: cacheId

description: The cache identifier of the service worker (can be any string). Change this property to force the service worker to reload in browsers.


key: offlineRoute

description: The route to the page to show when offline.


key: registerServiceWorker

description: Determines if a script that registers the service worker should be injected into the bottom of the HTML page.


key: registerWebmanifest

description: Determines if a meta tag that points to the web manifest should be inserted at the end of the head element.


key: routesToPreCache

description: A comma separated list of routes to pre-cache when service worker installs in the browser.


key: strategy

description: Selects one of the predefined service worker types.

enum: cacheFirst cacheFirstSafe minimal networkFirst

default: cacheFirstSafe


key: ApiKey

description: An elmah.io API key with the Messages | Write permission.


key: LogId

description: The Id of the elmah.io log to store messages in.


key: Application

description: An application name to put on all error messages.


key: HandledStatusCodesToLog

description: A list of HTTP status codes (besides 404) to log even though no exception is thrown.


key: TreatLoggingAsBreadcrumbs

description: Include log messages from Microsoft.Extensions.Logging as breadcrumbs.


key: HeartbeatId

description: The Id of the elmah.io heartbeat to notify.


key: protocols

description: The protocols enabled on the endpoint.


key: certificate

description: Certificate configuration.

default: My

enum: LocalMachine CurrentUser

default: CurrentUser


key: Path

description: The certificate file path. If a file path is specified then the certificate will be loaded from the file system.


key: KeyPath

description: The certificate key file path. Available in .NET 5 and later.


key: Password

description: The certificate password used to access the private key.


key: Subject

description: The certificate subject. If a subject is specified then the certificate will be loaded from the certificate store.


key: Store

description: The certificate store name. Defaults to 'My'.


key: Location

description: The certificate store location. Defaults to 'CurrentUser'.


key: AllowInvalid

description: A value indicating whether or not to load certificates that are considered invalid. Defaults to false.


key: sslProtocols

description: Specifies allowable SSL protocols. Defaults to 'None' which allows the operating system to choose the best protocol to use, and to block protocols that are not secure. Unless your app has a specific reason not to, you should use this default. Available in .NET 5 and later.


key: clientCertificateMode

description: Specifies the client certificate requirements for a HTTPS connection. Defaults to 'NoCertificate'. Available in .NET 5 and later.

default: NoCertificate


key: kestrel

description: ASP.NET Core Kestrel server configuration.


key: Endpoints

description: Endpoints that Kestrel listens to for network requests. Each endpoint has a name specified by its JSON property name.


key: additionalProperties

description: Kestrel endpoint configuration.


key: Url

description: The scheme, host name, and port the endpoint will listen on. A Url is required.


key: Sni

description: Server Name Indication (SNI) configuration. This enables the mapping of client requested host names to certificates and other TLS settings. Wildcard names prefixed with '*.', as well as a top level '*' are supported. Available in .NET 5 and later.


description: Endpoint SNI configuration.


key: EndpointDefaults

description: Default configuration applied to all endpoints. Named endpoint specific configuration overrides defaults.


key: Certificates

description: Certificates that Kestrel uses with HTTPS endpoints. Each certificate has a name specified by its JSON property name. The 'Default' certificate is used by HTTPS endpoints that haven't specified a certificate.


key: logLevelThreshold

description: Log level threshold.

enum: Trace Debug Information Warning Error Critical None


key: logLevel

description: Log level configurations used when creating logs. Only logs that exceeds its matching log level will be enabled. Each log level configuration has a category specified by its JSON property name. For more information about configuring log levels, see https://docs.microsoft.com/aspnet/core/fundamentals/logging/#configure-logging.


key: logging

description: Configuration for Microsoft.Extensions.Logging.

default: simple


key: FormatterName

description: Name of the log message formatter to use. Defaults to 'simple'.


key: FormatterOptions

description: Log message formatter options. Additional properties are available on the options depending on the configured formatter. The formatter is specified by FormatterName.


key: IncludeScopes

description: Include scopes when true. Defaults to false.


key: TimestampFormat

description: Format string used to format timestamp in logging messages. Defaults to null.


key: UseUtcTimestamp

description: Indication whether or not UTC timezone should be used to for timestamps in logging messages. Defaults to false.


key: LogToStandardErrorThreshold

description: The minimum level of messages are written to Console.Error.


description: Logging configuration for a provider. The provider name must match the configuration's JSON property property name.


key: allowedHosts

description: ASP.NET Core host filtering middleware configuration. Allowed hosts is a semicolon-delimited list of host names without port numbers. Requests without a matching host name will be refused. Host names may be prefixed with a '*.' wildcard, or use '*' to allow all hosts.


key: connectionStrings

description: Connection string configuration. Get connection strings with the IConfiguration.GetConnectionString(string) extension method.


description: Connection string configuration. Each connection string has a name specified by its JSON property name.


key: NLog

description: NLog configuration

enum: Trace Debug Info Warn Error Fatal Off

default: Off

default: false

type: number string boolean


key: autoReload

description: Automatically reload the NLog configuration when notified that appsettings.json file has changed.


key: throwConfigExceptions

description: Throws an exception when there is a config error? If not set, then throwExceptions will be used for this setting.


key: throwExceptions

description: Throws an exception when there is an error. For unit testing only and advanced troubleshooting.


key: internalLogLevel

description: The minimal log level for the internal logger.


key: internalLogFile

description: Write internal log to the specified filepath


key: internalLogToConsole

description: Write internal log to a console


key: internalLogToConsoleError

description: Write internal log to a console with error stream


key: globalThreshold

description: Log events below this threshold are not logged.


key: autoShutdown

description: Automatically call `LogFactory.Shutdown` on AppDomain.Unload or AppDomain.ProcessExit


key: extensions

description: Load NLog extension packages for additional targets and layouts


key: assembly

description: Assembly Name of the NLog extension package.


key: prefix

description: Appends prefix to all type-names loaded from the assembly


key: assemblyFile

description: Absolute filepath to the Assembly-file of the NLog extension package.


key: variables

description: Key-value pair of variables


key: targetDefaultWrapper

description: Wrap all defined targets with this custom target wrapper.


key: async

description: Wrap all defined targets using AsyncWrapper with OverflowAction=Discard for better performance.


key: NLogRulesItem

description: Redirect LogEvents from matching Logger objects to specified targets

enum: Trace Debug Info Warn Error Fatal

enum: Neutral Log Ignore LogFinal IgnoreFinal

default: Neutral

default: Ignore


key: logger

description: Match Logger objects based on their Logger-name. Can use wildcard characters ('*' or '?').


key: ruleName

description: Rule identifier to allow rule lookup with Configuration.FindRuleByName and Configuration.RemoveRuleByName.


key: level


key: levels

description: Comma separated list of levels that this rule matches.


key: minLevel


key: maxLevel


key: finalMinLevel


key: writeTo

description: Name or names of a target - separated by comma. Remove this property for sending events to the blackhole.


key: final

description: Ignore further rules if this one matches.


key: filters


key: items


key: action

description: Result action when filter matches logevent.


key: filterDefaultAction

description: Default action if none of the filters match.


key: umbraco

description: Configuration of Open Source .NET CMS - Umbraco


key: LuceneDirectoryFactory

description: Lucene directory factory type


key: Disabled

description: Indicating whether the exception filter is disabled


key: MaxLogAge

description: Maximum age of a log file - https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-timespan-format-strings


key: BrowsableFileExtensions

description: Allowed file extensions (including the period .) that should be accessible from the browser


key: MaxQueryStringLength

description: Value for the maximum query string length


key: MaxRequestLength

description: Value for the maximum request length


key: EnableTours

description: Indicating whether back-office tours are enabled


key: AssembliesAcceptingLoadExceptions

description: A CSV string of assemblies that accept load exceptions during type finder operations


key: umbracoActiveDirectory

description: Configuration of Active Directory for Umbraco CMS


key: Domain

description: Active Directory Domain


key: AllowedUploadFiles

description: Collection of file extensions without . that are allowed for upload


key: DisallowedUploadFiles

description: Collection of file extensions without . that are disallowed for upload


key: AutoFillImageProperties

description: Imaging autofill following media file upload fields

default: umbracoFile

default: umbracoExtension

default: umbracoHeight

default: umbracoBytes

default: umbracoWidth


key: ImageFileTypes

description: Collection of accepted image file extensions


key: LoginBackgroundImage

description: Path to the login screen background image


key: LoginLogoImage

description: Path to the login screen logo image


key: MacroErrors

description: Macro error behaviour

enum: Inline Silent Throw Content


key: Email

description: Email address used for notifications


key: DisableHtmlEmail

description: Whether HTML email notifications should be disabled


key: PreviewBadge

description: Preview badge mark-up


key: ResolveUrlsFromTextString

description: URLs should be resolved from text strings


key: ShowDeprecatedPropertyEditors

description: Deprecated property editors should be shown


key: ContentId

description: An int of the content


key: ContentKey

description: A guid of the content


key: ContentXPath

description: An XPath query for the content


key: Culture

description: Content culture


key: LogIncompletedScopes

description: Indicating whether incompleted scopes should be logged


key: DumpOnTimeoutThreadAbort

description: Indicating whether memory dumps on thread abort should be taken


key: ReservedUrls

description: CSV string of reserved URLs (must end with a comma)


key: ReservedPaths

description: CSV string of reserved paths (must end with a comma)


key: TimeOut

description: Duration of timeout https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-timespan-format-strings


key: DefaultUILanguage

description: Default UI language of Umbraco backoffice

default: en-US


key: HideTopLevelNodeFromPath

description: Indicating whether to hide the top level node from the path


key: UseHttps

description: Indicating whether HTTPS should be used


key: VersionCheckPeriod

description: Check for new version. Period in days


key: IconsPath

description: Path to Umbraco Icons for backoffice


key: UmbracoCssPath

description: Path to store CSS files used for website built with Umbraco

default: ~/css


key: UmbracoMediaPath

description: Path to store media files

default: ~/media


key: InstallMissingDatabase

description: Indicating whether to install the database when it is missing


key: DisableElectionForSingleServer

description: Indicating whether to disable the election for a single server


key: NoNodesViewPath

description: Path to view when the website built with Umbraco has no content nodes


key: WaitTimeBetweenCalls

description: The amount of time to wait between calls to the database on the background thread https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-timespan-format-strings


key: StaleServerTimeout

description: The time span to wait before considering a server stale, after it has last been accessed https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-timespan-format-strings


key: MaxProcessingInstructionCount

description: The maximum number of instructions that can be processed at startup; otherwise the server cold-boots (rebuilds its caches)


key: TimeToRetainInstructions

description: The time to keep instructions in the database. Records older than this number will be pruned https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-timespan-format-strings


key: TimeBetweenSyncOperations

description: The time to wait between each sync operations https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-timespan-format-strings


key: TimeBetweenPruneOperations

description: The time to wait between each prune operations https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-timespan-format-strings


key: From

description: Email address to use for messages


key: Host

description: SMTP Server hostname


key: Port

description: SMTP Server Port Number


key: SecureSocketOptions

description: Secure socket options for SMTP server

enum: None Auto SslOnConnect StartTls StartTlsWhenAvailable

default: Auto


key: PickupDirectoryLocation

description: SMTP pick-up directory path


key: DeliveryMethod

description: SMTP delivery method

default: Network


key: Username

description: SMTP server username


key: Password

description: SMTP server password


key: Enabled

description: Indicating whether health check notifications are enabled


key: FirstRunTime

description: The first run time of a healthcheck notification in crontab format


key: Period

description: The period of the healthcheck notifications are run https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-timespan-format-strings


key: NotificationMethods

description: A collection of health check notification methods that are set by their alias such as 'email'

enum: Summary Detailed

default: Summary


description: Indicating whether the health check notification method is enabled


key: Verbosity

description: The health check notifications reporting verbosity


key: FailureOnly

description: Indicating whether the health check notifications should occur on failures only


key: Settings

description: An object of Health Check Notification provider specific settings. For the email notification it uses a setting 'RecipientEmail'


key: Id

description: Guid of healthcheck to disable


key: Debug

description: Indicating whether umbraco is running in [debug mode]


key: LocalTempStorageLocation

description: The location of temporary files

default: Default

enum: Default EnvironmentTemp


key: BrowserMaxAge

description: Browser image cache maximum age https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-timespan-format-strings


key: CacheMaxAge

description: Image cache maximum age https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-timespan-format-strings


key: CachedNameLength

description: Length of the cached name


key: CacheFolder

description: Location of media cache folder


key: MaxWidth

description: Value for the maximum resize width


key: MaxHeight

description: Value for the maximum resize height


key: DisableKeepAliveTask

description: Indicating whether the keep alive task is disabled


key: KeepAlivePingUrl

description: Keep alive ping URL. {umbracoApplicationUrl} is replaced


key: Commands

description: Commands to add to the TinyMCE Richtext editor


key: Plugins

description: An array of TinyMCE Plugins to load such as 'paste', 'table'


key: CustomConfig

description: Custom configuration for TinyMCE and its plugins


key: ValidElements

description: A CSV string of valid HTML elements in the richtext editor. Ex: iframe[*],button[class|title]


key: InvalidElements

description: A CSV string of invalid HTML elements in the richtext editor. Ex: font


key: Name

description: Friendly name of Richtext Editor Command


key: Alias

description: Alias of the Richtext Editor Command


key: Mode

description: Set how the Richtext Editor Command can be used. Such as when a selection is made

enum: Insert Selection All


key: AddTrailingSlash

description: Indicating whether to add a trailing slash to URLs


key: CharCollection

description: Character collection for replacements


key: ConvertUrlsToAscii

description: Indicating whether to convert URLs to ASCII (valid values: true, try or false)

enum: try true false

default: try


key: CacheBuster

description: Cache buster type to use

enum: Version AppDomain Timestamp

default: Version


key: AllowPasswordReset

description: Indicating whether to allow user password reset


key: AuthCookieDomain

description: Authorization cookie domain


key: AuthCookieName

description: The authorization cookie name


key: HideDisabledUsersInBackOffice

description: Indicating whether to hide disabled users in the back-office


key: KeepUserLoggedIn

description: Indicating whether to keep the user logged in


key: UsernameIsEmail

description: Indicating whether the user's email address is to be considered as their username


key: TryMatchingEndpointsForAllPages

description: Indicating whether to check if any routed endpoints match a front-end request before the Umbraco dynamic router tries to map the request to an Umbraco content item


key: TrySkipIisCustomErrors

description: Indicating whether IIS custom errors should be skipped


key: InternalRedirectPreservesTemplate

description: Indicating whether an internal redirect should preserve the template


key: DisableAlternativeTemplates

description: Indicating whether the use of alternative templates are disabled


key: ValidateAlternativeTemplates

description: Indicating whether the use of alternative templates should be validated


key: DisableFindContentByIdPath

description: Indicating whether find content ID by path is disabled


key: DisableRedirectUrlTracking

description: Indicating whether redirect URL tracking is disabled


key: InstallUnattended

description: Indicating whether unattended installs are enabled


key: UpgradeUnattended

description: Indicating whether unattended upgrades are enabled


key: UnattendedUserName

description: Use for creating a user with a name for Unattended Installs


key: UnattendedUserEmail

description: Use for creating a user with an email for Unattended Installs


key: UnattendedUserPassword

description: Use for creating a user with a password for Unattended Installs


key: ModelsMode

description: ModelsBuilder generation mode

enum: Nothing InMemoryAuto SourceCodeManual SourceCodeAuto

default: InMemoryAuto


key: ModelsNamespace

description: Namespace to use when generating strongly typed models


key: ModelsDirectory

description: Location to generate ModelsBuilder models


key: DebugLevel

description: Indicates the debug level. For internal / development use. Set to greater than zero to enable detailed logging.


key: AcceptUnsafeModelsDirectory

description: Indicates that the directory indicated in ModelsDirectory is allowed to be outside the website root (e.g. ~/../../some/place). Because that can be a potential security risk, it is not allowed by default.


key: FlagOutOfDateModels

description: Indicates whether out-of-date models (i.e. after a content type or data type has been modified) should be flagged.


description: A manifest describing a Stripe App.


key: extends

description: The base manifest that this local manifest will extend.


description: Configuration options for how to display the app in the Dashboard.


description: Configure the content security policy for your app.


key: controller

description: Specifies the location of the controller executable and activation parameters.


key: contextEnvironmentVariables

description: Array of environment variable names. These variables are mixed-up into hash that determines the location service pipe name. The order is significant.


key: additionalEnvironmentVariables

description: An object with properties like "environment variable name": "value" that describes what environment variables to set for the Hub Controller.


description: The value of the environment variable to set.


key: rootDir

description: The path to the directory immediately under which are folders that contain *.servicehub.host.json files.


description: The path to the directory immediately under which are folders that contain *.servicehub.service.json files.


key: discoveryServices

description: Service names of optional discovery service modules. Controller will use them to locate a service which it cannot find in the services folder.


key: format

description: Content Format.


key: path

description: Path or pattern of artifacts.


key: items

description: Path or pattern of artifacts.


key: type

description: Content Type.


description: Folder Cache Definition.


description: Script that is used to calculate cache key.


key: folder

description: Path of a folder to cache.


description: In case of a cache miss this script will be executed.


description: Boolean expression. A flag to check if contents of folder has changed after a cache hit.


description: Destination path.


description: Environment variable name.


description: Boolean expression that can use environment variables.


key: always

description: ALWAYS commands.


description: List of task names this task depends on.


key: env

description: Map represented as an object.


key: environment

description: Map represented as an object.


description: Lock name for triggering and execution


key: experimental


description: ON_FAILURE commands.


description: Content Format.


description: Path or pattern of artifacts.


description: Path or pattern of artifacts.


description: Content Type.


description: Folder Cache Definition.


description: Path of a folder to cache.


description: ON_SUCCESS commands.


description: Destination path.


description: Environment variable name.


Windows version of container.


key: platform

description: Container Platform.

enum: linux windows


description: List of required labels on a PR.


key: skip


key: stateful


description: Task timeout in minutes


description: Trigger type

enum: automatic manual


description: GKE cluster name.


description: Map represented as an object.


description: Map represented as an object.


description: Lock name for triggering and execution


key: namespace

description: Kubernetes namespace to schedule CI jobs in.


key: resources

description: Pipe resources


description: Pipe step


description: Content Format.


description: Path or pattern of artifacts.


description: Path or pattern of artifacts.


description: Content Type.


description: Folder Cache Definition.


description: Path of a folder to cache.


description: Destination path.


description: Environment variable name.


description: ALWAYS commands.


key: image

description: Docker Image to use.


description: ON_FAILURE commands.


description: ON_SUCCESS commands.


description: Task timeout in minutes


description: Trigger type


key: zone

description: Google Cloud zone of the cluster.


description: Map represented as an object.


description: Map represented as an object.


description: Lock name for triggering and execution


description: List of required labels on a PR.


description: Pipe resources


description: Pipe step


description: Content Format.


description: Path or pattern of artifacts.


description: Path or pattern of artifacts.


description: Content Type.


description: Folder Cache Definition.


description: Path of a folder to cache.


description: Destination path.


description: Environment variable name.


description: ALWAYS commands.


description: Docker Image to use.


description: ON_FAILURE commands.


description: ON_SUCCESS commands.


description: Task timeout in minutes


description: Trigger type


description: Cirrus CI task definition.

enum: westus eastus

enum: freebsd linux windows solaris

required: image port


description: Azure Container Instance definition.


description: Docker Image.


description: Container Platform.


key: region

description: Azure zone.


description: Compute Engine instance definition.


description: Image name or family.


description: Google Cloud project of an image.


description: VM platform.


key: container

description: Container definition for Community Cluster.


description: Additional Container definition.


key: command

description: Container CMD to override.


description: Map represented as an object.


description: Map represented as an object.


key: port

description: Port exposed by the container.


key: privileged


description: Container readiness probe command.


description: Arguments for Docker build


key: dockerfile

description: Relative path to Dockerfile to build container from.


description: Docker Image to use.


key: kvm


description: AWS EC2 definition.


description: AMI Image.


description: Image Platform.


description: AWS region.


description: EKS Container definition.


description: Docker Image.


description: EKS cluster name.


description: Lock name for triggering and execution


description: macOS Virtual Machine definition for Community Cluster.


description: FreeBSD VM image.


description: Image family.


description: Google Compute Engine Virtual Machine definition.


key: items

description: Additional Container definition.


description: Container CMD to override.


key: env

description: Map represented as an object.


key: environment

description: Map represented as an object.


description: Port exposed by the container.


description: Container readiness probe command.


description: Container image.


description: Image name.


description: Google Cloud project of an image.


key: preemptible


key: scopes

description: Google Cloud Scopes of the VM.


description: Google Cloud zone where to start a VM.


key: platform

description: VM platform.


key: type

description: Machine Type.


description: Google Kubernetes Engine Container definition.


description: Docker Image.


description: Google Cloud project of an image used to build Docker container from Dockerfile.


description: GKE cluster name.


description: Arguments for Docker build


description: Relative path to Dockerfile.


key: namespace


description: Container Platform.


description: Google Cloud zone of the cluster.


key: image

description: macOS VM image.


description: ON_FAILURE commands.


key: format

description: Content Format.


key: path

description: Path or pattern of artifacts.


description: Path or pattern of artifacts.


description: Content Type.


description: Folder Cache Definition.


key: folder

description: Path of a folder to cache.


description: Destination path.


description: Environment variable name.


description: ON_SUCCESS commands.


description: Persistent Worker definition.

enum: darwin linux windows


key: isolation

description: Persistent Worker isolation.


key: parallels

description: Parallels VM isolation.


description: Image name.


key: password

description: SSH password


description: Image Platform.


key: user

description: SSH username


key: labels

description: Labels for selection.


description: List of required labels on a PR.


key: skip


key: stateful


description: Task timeout in minutes


description: Trigger type


description: Windows Container definition for Community Cluster.


description: Arguments for Docker build


key: dockerfile


description: Docker Image to use.


Windows version of container.


description: Azure Container Instance definition.


description: Docker Image.


description: Container Platform.


key: region

description: Azure zone.


description: Compute Engine instance definition.


description: Image name or family.


description: Google Cloud project of an image.


description: VM platform.


key: container


key: items

description: Additional Container definition.


key: command

description: Container CMD to override.


key: env

description: Map represented as an object.


key: environment

description: Map represented as an object.


key: port

description: Port exposed by the container.


key: privileged


description: Container readiness probe command.


description: Arguments for Docker build


key: image

description: Docker Image to use.


key: kvm


description: AWS EC2 definition.


description: AMI Image.


key: platform

description: Image Platform.


description: AWS region.


description: EKS Container definition.


description: Docker Image.


description: EKS cluster name.


key: namespace


key: experimental


description: FreeBSD VM image.


description: Image family.


description: Additional Container definition.


description: Container CMD to override.


description: Map represented as an object.


description: Map represented as an object.


description: Port exposed by the container.


description: Container readiness probe command.


description: Container image.


description: Image name.


description: Google Cloud project of an image.


key: preemptible


key: scopes

description: Google Cloud Scopes of the VM.


key: zone

description: Google Cloud zone where to start a VM.


description: VM platform.


key: type

description: Machine Type.


description: Docker Image.


description: GKE cluster name.


description: Arguments for Docker build


key: dockerfile

description: Relative path to Dockerfile.


description: Container Platform.


description: Google Cloud zone of the cluster.


description: macOS VM image.


description: Persistent Worker definition.


key: isolation

description: Persistent Worker isolation.


key: parallels

description: Parallels VM isolation.


description: Image name.


key: password

description: SSH password


description: Image Platform.


key: user

description: SSH username


key: labels

description: Labels for selection.


key: skip


key: stateful


description: Task timeout in minutes


description: Trigger type


description: Arguments for Docker build


key: image

description: Docker Image to use.


Windows version of container.


description: Configure Aerleon's aclgen, aclcheck, and pol2yaml command line tools


description:
aclgen and pol2yaml will search this directory recursively for policy files to process, except if the flag `--policy_file` is used to give a specific input file (aclgen only).

Relative paths that appear in 'include' directives will be resolved against base_directory.

The default value is './policies'.


description:
All network and service definition files in this directory will be loaded and used to resolve symbolic network and service names.

Unlike base_directory, definitions_directory is not searched recursively for input files.

The default value is './def'.


description:
aclgen will place all generated ACLs in this directory. For `aclgen` the default value is the current directory.

pol2yaml will place each converted file adjacent to its input file by default. If output_directory is given, pol2yaml will mirror the directory structure of the input files in the output_directory, potentially creating directories in the process.


key: optimize

description:
Causes aclgen to produce a more compact address book by collapsing adjacent or overlapping CIDR expressions within the same network.

On some platforms (Juniper SRX and platforms configured with the 'object-group' option) address book compression is restricted to only collapse addresses that share the same network token (name).

This flag is not enabled by default, although a secondary address book compression pass is always performed for Juniper SRX and Palo Alto Networks firewalls regardless of this setting.


key: recursive

description: UNUSED. This field is not used.


key: debug

description: Causes aclgen to display very detailed log messages if true. The default value is false.


key: verbose

description: UNUSED. This field is not used. To get detailed log messages, use 'debug'.


description:
Controls the number of parallel processes used by aclgen to render ACLs. The aclgen program uses Python's OS process-based multiprocessing, so setting max_renderers to '2' would cause aclgen to spawn two OS processes that will generate ACLs.

Setting max_renderers to '1' will disable multiprocessing.

By default, max_renderers is set to '10'. Users may wish to set this to the number of available CPUs on the current system.


description: Causes aclgen to produce a warning if any unreachable term is encountered if true. The default value is false.


description:
aclgen will produce a warning if it encounters a term set to expire in the near future. Expired terms are ignored. Setting exp_info controls the number of weeks ahead that aclgen will check for soon-to-expire terms.

The default value is '2' (two weeks).


key: CodeGeneration

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

enum: None PascalCase SnakeKebabToPascalCase


key: schema

description: This is used as the default 'Schema' for all child objects.


key: columnNameIsDeleted

description: Defaults to 'IsDeleted'.


key: columnNameTenantId

description: Defaults to 'TenantId'.


key: columnNameOrgUnitId

description: Defaults to 'OrgUnitId'.


key: columnNameRowVersion

description: Defaults to 'RowVersion'.


key: columnNameCreatedBy

description: Defaults to 'CreatedBy'.


key: columnNameCreatedDate

description: Defaults to 'CreatedDate'.


key: columnNameUpdatedBy

description: Defaults to 'UpdatedBy'.


key: columnNameUpdatedDate

description: Defaults to 'UpdatedDate'.


key: columnNameDeletedBy

description: Defaults to 'UpdatedBy'.


key: columnNameDeletedDate

description: Defaults to 'UpdatedDate'.


key: orgUnitJoinSql

description: Defaults to '[Sec].[fnGetUserOrgUnits]()'.


key: checkUserPermissionSql

description: Defaults to '[Sec].[spCheckUserHasPermission]'.


key: getUserPermissionSql

description: Defaults to '[Sec].[fnGetUserHasPermission]'.


key: autoDotNetRename

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


key: efModel

description: This can be overridden within the 'Table'(s).


key: outbox

description: Defaults to 'false'.


key: outboxSchema

description: Defaults to 'Outbox' (literal).


key: outboxSchemaCreate

description: Defaults to 'true'.


key: outboxTable

description: Defaults to 'EventOutbox' (literal).


key: outboxEnqueueStoredProcedure

description: Defaults to 'spEventOutboxEnqueue' (literal).


key: outboxDequeueStoredProcedure

description: Defaults to 'spEventOutboxDequeue' (literal).


key: pathBase

description: Defaults to 'Company' (runtime parameter) + '.' + 'AppName' (runtime parameter). For example 'Beef.Demo'.


key: pathDatabaseSchema

description: Defaults to 'PathBase' + '.Database/Schema' (literal). For example 'Beef.Demo.Database/Schema'.


key: pathDatabaseMigrations

description: Defaults to 'PathBase' + '.Database/Migrations' (literal). For example 'Beef.Demo.Database/Migrations'.


key: pathBusiness

description: Defaults to 'PathBase' + '.Business' (literal). For example 'Beef.Demo.Business'.


key: orgUnitImmutable

description: This is only applicable for stored procedures.


key: namespaceBase


key: namespaceCommon

description: Defaults to 'NamespaceBase' + '.Common' (literal). For example 'Beef.Demo.Common'.


key: namespaceBusiness

description: Defaults to 'NamespaceBase' + '.Business' (literal). For example 'Beef.Demo.Business'.


key: namespaceOutbox

description: Defaults to 'NamespaceBusiness'.


key: Table

description: The 'Table' object identifies an existing database 'Table' (or 'View') and defines its code-generation characteristics.


key: schema

description: Defaults to 'CodeGeneration.Schema'.


key: alias

description: Will automatically default where not specified.


key: includeColumns

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


key: excludeColumns

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


key: aliasColumns

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


key: getAll

description: The 'GetAllOrderBy' is used to specify the 'GetAll' query sort order.


key: getAllOrderBy

description: This relates to the 'GetAll' selection.


key: merge

description: This will also require a 'Udt' (SQL User Defined Table) and 'Tvp' (.NET Table-Valued Parameter) to function.


key: efModel

description: Defaults to 'CodeGeneration.EfModel'.


key: efModelName

description: Defaults to 'Name' applying the 'CodeGeneration.AutoDotNetRename'.


key: udtExcludeColumns

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


key: orgUnitImmutable

description: Defaults to 'CodeGeneration.OrgUnitImmutable'. This is only applicable for stored procedures.


key: columnNameIsDeleted

description: Defaults to 'CodeGeneration.IsDeleted'.


key: columnNameTenantId

description: Defaults to 'CodeGeneration.TenantId'.


key: columnNameOrgUnitId

description: Defaults to 'CodeGeneration.OrgUnitId'.


key: columnNameRowVersion

description: Defaults to 'CodeGeneration.RowVersion'.


key: columnNameCreatedBy

description: Defaults to 'CodeGeneration.CreatedBy'.


key: columnNameCreatedDate

description: Defaults to 'CodeGeneration.CreatedDate'.


key: columnNameUpdatedBy

description: Defaults to 'CodeGeneration.UpdatedBy'.


key: columnNameUpdatedDate

description: Defaults to 'CodeGeneration.UpdatedDate'.


key: columnNameDeletedBy

description: Defaults to 'CodeGeneration.UpdatedBy'.


key: columnNameDeletedDate


key: StoredProcedure

description: The code generation for an 'StoredProcedure' is primarily driven by the 'Type' property. This encourages (enforces) a consistent implementation for the standardised **CRUD** (Create, Read, Update and Delete) actions, as well as supporting 'Upsert', 'Merge' and ad-hoc queries as required.

enum: Get GetColl Create Update Upsert Delete Merge


key: name

description: See 'StoredProcedureName' for the actual name used in the database.


key: type

description: Defaults to 'GetColl'.


key: paging

description: This only applies where the stored procedure operation 'Type' is 'GetColl'.


key: storedProcedureName

description: Defaults to 'sp' + 'Table.Name' + 'Name'; e.g. 'spTableName' or 'spPersonGet'.


key: reselectStatement

description: Defaults to '[{{Table.Schema}}].[sp{{Table.Name}}Get]' passing the primary key column(s).


key: intoTempTable

description: A 'Select * from #TempTable' is also performed (code-generated) where the stored procedure operation 'Type' is 'GetColl'.


key: mergeOverrideIdentityColumns

description: This is used to override the default behaviour of using the primary key column(s).


key: orgUnitImmutable

description: Defaults to 'Table.OrgUnitImmutable'.


key: includeColumns

description: Where not specified this indicates that all 'Columns' are to be included. Only filters the columns where 'Type' is 'Get', 'GetColl', 'Create', 'Update' or 'Upsert'.


key: excludeColumns

description: Where not specified this indicates no 'Columns' are to be excluded. Only filters the columns where 'Type' is 'Get', 'GetColl', 'Create', 'Update' or 'Upsert'.


key: Parameter

description: The 'Parameter' is used to define a stored procedure parameter and its charateristics. These are in addition to those that are automatically inferred (added) by the selected 'StoredProcedure.Type'.

enum: EQ NE LT LE GT GE LIKE


key: column

description: Defaults to 'Name'.


key: nullable

description: Note that when the parameter value is 'NULL' it will not be included in the query.


key: operator

description: Defaults to 'EQ'.


key: Where

description: The 'Where' object defines an additional where 'Statement' to be added. This is in addition to those automatically added based on the 'StoredProcedure.Type'.


key: OrderBy

description: The 'OrderBy' object defines the query order. Only valid for 'StoredProcedure.Type' of 'GetAll'.

enum: Ascending Descending


key: order

description: Defaults to 'Ascending'.


key: Execute

description: The _Execute_ object enables additional TSQL statements to be embedded within the stored procedure.

enum: Before After


key: location

description: Defaults to 'After'.


key: Relationship

description: The 'Relationship' object enables the definition of an entity framework (EF) model relationship.

enum: OneToMany ManyToOne

enum: NoAction Cascade ClientCascade ClientNoAction ClientSetNull Restrict SetNull


key: schema

description: Defaults to 'CodeGeneration.Schema'.


key: type

description: Defaults to 'OneToMany'.


key: principalKeyColumns

description: Typically this is only used where referencing property(s) other than the primary key as the principal property(s).


key: onDelete

description: Defaults to 'NoAction'. See https://learn.microsoft.com/en-us/dotnet/api/microsoft.entityframeworkcore.deletebehavior for more information.


key: autoInclude

description: Defaults to 'false'.


key: propertyName

description: Defaults to 'Name' using the 'CodeGeneration.AutoDotNetRename' option.


key: efModelName


key: Query

description: The 'Query' object enables the definition of more complex multi-table queries ('Joins') that would primarily result in a database _View_. The primary table 'Name' for the query is required to be specified. Multiple queries can be specified for the same table(s). The 'IncludeColumns' and 'ExcludeColumns' provide a shorthand to include or exclude selected columns; with the 'AliasColumns' providing a means to rename where required (for example duplicate name). Additional 'Where' and 'Order' configuration can also be added as required.


key: alias

description: Will automatically default where not specified.


key: includeColumns

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


key: excludeColumns

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


key: aliasColumns

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


key: viewName

description: Defaults to 'vw' + 'Name'; e.g. 'vwTableName'.