description:
The main title for the project documentation.
https://www.mkdocs.org/user-guide/configuration/#site_name

description:
A set of key-value pairs, where the values can be any valid YAML construct, that will be passed to the template. This allows for great flexibility when creating custom themes.
https://www.mkdocs.org/user-guide/configuration/#extra

description:
A list of paths to Python scripts (relative to mkdocs.yml) that are loaded and used as plugin instances.
https://www.mkdocs.org/user-guide/configuration/#hooks

description:
Set a list of JavaScript files in your docs_dir to be included by the theme. See the example in extra_css for usage.
https://www.mkdocs.org/user-guide/configuration/#extra_javascript

description:
A list of plugins (with optional configuration settings) to use when building the site. See the Plugins documentation for full details.
https://www.mkdocs.org/user-guide/configuration/#plugins

description:
Set a list of CSS files in your docs_dir to be included by the theme. For example, the following example will include the extra.css file within the css subdirectory in your docs_dir.
https://www.mkdocs.org/user-guide/configuration/#extra_css

description:
Set the copyright information to be included in the documentation by the theme.
https://www.mkdocs.org/user-guide/configuration/#copyright

default: gh-pages

description:
Set the remote branch to commit to when using gh-deploy to deploy to GitHub Pages. This option can be overridden by a command line option in gh-deploy.
https://www.mkdocs.org/user-guide/configuration/#remote_branch

description:
Set the canonical URL of the site. This will add a link tag with the canonical URL to the head section of each HTML page. If the 'root' of the MkDocs site will be within a subdirectory of a domain, be sure to include that subdirectory in the setting (https://example.com/foo/).
https://www.mkdocs.org/user-guide/configuration/#site_url

description:
This setting controls the style used for linking to pages within the documentation.
https://www.mkdocs.org/user-guide/configuration/#use_directory_urls

description:
Determines how warnings are handled. Set to true to halt processing when a warning is raised. Set to false to print a warning and continue processing.
https://www.mkdocs.org/user-guide/configuration/#strict

default: en

description: A code representing the language of your site.

description: A list of templates to render as static pages. The templates must be located in either the theme's template directory or in the custom_dir defined in the theme configuration.

description: A directory containing a custom theme. This can either be a relative directory, in which case it is resolved relative to the directory containing your configuration file or it can be an absolute directory path from the root of your local file system.

default: mkdocs

description: The string name of a known installed theme, or null if using a local custom theme.

description:
Sets the theme and theme specific configuration of your documentation site.
https://www.mkdocs.org/user-guide/configuration/#theme

description:
This setting is used to determine the format and layout of the global navigation for the site.
https://www.mkdocs.org/user-guide/configuration/#nav

description:
When set, provides the name for the link to your repository on each page.
https://www.mkdocs.org/user-guide/configuration/#repo_name

default: site

description:
The directory where the output HTML and other files are created. This can either be a relative directory, in which case it is resolved relative to the directory containing your configuration file, or it can be an absolute directory path from the root of your local file system.
https://www.mkdocs.org/user-guide/configuration/#site_dir

description:
Determines additional directories to watch when running mkdocs serve.
https://www.mkdocs.org/user-guide/configuration/#watch

description:
Define the parent for a configuration file. The path must be relative to the location of the primary file.
https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance

description:
Determines the address used when running mkdocs serve. Must be of the format IP:PORT.
https://www.mkdocs.org/user-guide/configuration/#dev_addr

description:
When set, provides a link to your repository (GitHub, Bitbucket, GitLab, ...) on each page.
https://www.mkdocs.org/user-guide/configuration/#repo_url

default: origin

description:
Set the remote name to push to when using gh-deploy to deploy to GitHub Pages. This option can be overridden by a command line option in gh-deploy.
https://www.mkdocs.org/user-guide/configuration/#remote_name

default: docs

description:
The directory containing the documentation source markdown files. This can either be a relative directory, in which case it is resolved relative to the directory containing your configuration file, or it can be an absolute directory path from the root of your local file system.
https://www.mkdocs.org/user-guide/configuration/#docs_dir

description:
This setting lets you enable a list of extensions beyond the ones that MkDocs uses by default (meta, toc, tables, and fenced_code).
https://www.mkdocs.org/user-guide/configuration/#markdown_extensions

description:
Set the site description. This will add a meta tag to the generated HTML header.
https://www.mkdocs.org/user-guide/configuration/#site_description

description:
Set a list of templates in your docs_dir to be built by MkDocs. To see more about writing templates for MkDocs read the documentation about [custom themes] and specifically the section about the [available variables] to templates. See the example in extra_css for usage.
https://www.mkdocs.org/user-guide/configuration/#extra_templates

description:
Set the name of the author. This will add a meta tag to the generated HTML header.
https://www.mkdocs.org/user-guide/configuration/#site_author

description:
The path from the base repo_url to the docs directory when directly viewing a page, accounting for specifics of the repository host (e.g. GitHub, Bitbucket, etc), the branch, and the docs directory itself.
https://www.mkdocs.org/user-guide/configuration/#edit_uri

description:
The more flexible variant of edit_uri.
https://www.mkdocs.org/user-guide/configuration/#edit_uri_template

key: coreProperties


type: object

description: The pod this Toleration is attached to tolerates any taint that matches the triple <key,value,effect> using the matching operator <operator>.

type: string

description: Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.

description: Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

type: integer

description: TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

description: Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

description: Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.


description:
<!--${internal}--> ### mirror

Sniffs on TCP port, and send a copy of the data to listeners.

description:
<!--${internal}--> ### steal

Stealer supports 2 modes of operation:

1. Port traffic stealing: Steals all TCP data from a port, which is selected whenever the user listens in a TCP socket (enabling the feature is enough to make this work, no additional configuration is needed);

2. HTTP traffic stealing: Steals only HTTP traffic, mirrord tries to detect if the incoming data on a port is HTTP (in a best-effort kind of way, not guaranteed to be HTTP), and steals the traffic on the port if it is HTTP;

description:
<!--${internal}--> ### Off

Disables the incoming network feature.

description:
Allows selecting between mirrorring or stealing traffic.

Can be set to either `"mirror"` (default), `"steal"` or `"off"`.

- `"mirror"`: Sniffs on TCP port, and send a copy of the data to listeners. - `"off"`: Disables the incoming network feature. - `"steal"`: Supports 2 modes of operation:

1. Port traffic stealing: Steals all TCP data from a port, which is selected whenever the user listens in a TCP socket (enabling the feature is enough to make this work, no additional configuration is needed);

2. HTTP traffic stealing: Steals only HTTP traffic, mirrord tries to detect if the incoming data on a port is HTTP (in a best-effort kind of way, not guaranteed to be HTTP), and steals the traffic on the port if it is HTTP;

key: IncomingMode


description: <!--${internal}--> Mirror the rollout specified by [`RolloutTarget::rollout`].

description: <!--${internal}--> Rollout to mirror.

key: RolloutTarget


description: <!--${internal}--> Mirror the deployment specified by [`DeploymentTarget::deployment`].

description: <!--${internal}--> Deployment to mirror.

key: DeploymentTarget


description:
<!--${internal}--> ### override

Override any port lock and force close the original lock connection

description:
<!--${internal}--> ### continue

Continue with normal execution

description:
<!--${internal}--> ### abort

Abort Execution when trying to steal traffic from a target whose traffic is already being stolen.

description:
(Operator Only): Allows overriding port locks

Can be set to either `"continue"` or `"override"`.

- `"continue"`: Continue with normal execution - `"override"`: If port lock detected then override it with new lock and force close the original locking connection.

key: ConcurrentSteal


description: mirrord won't do anything fs-related, all operations will be local.

title: feature.fs.mode.local {#feature-fs-mode-local}

description: mirrord will run overrides on some file operations, but most will be local.

title: feature.fs.mode.localwithoverrides {#feature-fs-mode-localwithoverrides}

description: mirrord will read files from the remote, but won't write to them.

title: feature.fs.mode.read {#feature-fs-mode-read}

description: mirrord will read/write from the remote.

title: feature.fs.mode.write {#feature-fs-mode-write}

description:
Configuration for enabling read-only or read-write file operations.

These options are overriden by user specified overrides and mirrord default overrides.

If you set [`"localwithoverrides"`](#feature-fs-mode-localwithoverrides) then some files can be read/write remotely based on our default/user specified. Default option for general file configuration.

The accepted values are: `"local"`, `"localwithoverrides`, `"read"`, or `"write`.

key: FsModeConfig


description: <!--${internal}--> Mirror the pod specified by [`PodTarget::pod`].

description: <!--${internal}--> Pod to mirror.

key: PodTarget


description:
Configuration for the internal proxy mirrord spawns for each local mirrord session that local layers use to connect to the remote agent

This is seldom used, but if you get `ConnectionRefused` errors, you might want to increase the timeouts a bit.

```json { "internal_proxy": { "start_idle_timeout": 30, "idle_timeout": 5, } } ```

description:
How much time to wait while we don't have any active connections before exiting.

Common cases would be running a chain of processes that skip using the layer and don't connect to the proxy.

```json { "internal_proxy": { "idle_timeout": 30 } } ```

title: internal_proxy.idle_timeout {#agent-idle_timeout}

description:
How much time to wait for the first connection to the proxy in seconds.

Common cases would be running with dlv or any other debugger, which sets a breakpoint on process execution, delaying the layer startup and connection to proxy.

```json { "internal_proxy": { "start_idle_timeout": 60 } } ```

title: internal_proxy.start_idle_timeout {#agent-start_idle_timeout}

key: InternalProxyFileConfig


description: A plugin dependency

enum: AFTER BEFORE OMIT

description: Where to load this dependency in relation to the plugin. Defaults to OMIT

type: boolean

description: Whether this dependency's classpath should be joined by the plugin. Defaults to true

description: Whether this dependency is required for the plugin to load. Defaults to true

key: dependency


enum: sign-extension mutable-globals nontrapping-f2i bulk-memory simd threads exception-handling tail-calls reference-types multi-value gc memory64

key: webAssemblyFeatures


description: Key/value pairs that provide additional information about the object.

description: A set of distinct strings that provide additional information.

type: array

key: propertyBag


description: Sets the version of the SDK.

description: The name of the debug profile

description: Sets the working directory of the command.

description: The arguments to pass to the command.

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

description: The relative URL to launch in the browser.

format: uri

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

key: content


description: File format version

key: fileVersion


description: Translate all locales.

description: List of locales ID's to translate.

default: warning

enum: warning error ignore

description: How to handle missing translations for i18n.

key: buildersOptions


type: boolean string

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

description: The default schematics collection to use.

enum: npm cnpm yarn pnpm

description: Specify which package manager tool to use.

description: Control CLI specific console warnings

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

key: cliOptions


description: Flag to indicate if a directory is created.

description: When true, does not create test files.

description: Flag to skip the module import.

alias: m

description: Allows specification of the declaring module.

description: The selector to use for the directive.

format: html-selector

default: app

alias: p

description: The prefix to apply to generated selectors.

description: Specifies if declaring module exports the directive.

description: When true, does not create test files.

description: When true, does not create test files.

default: Child

enum: Child Root

description: The scope for the generated routing.

description: Generates a routing module.

description: Flag to control whether the CommonModule is imported.

alias: s

description: Specifies if the style will be in the ts file.

default: css

enum: css scss sass less styl

description: The file extension or preprocessor to use for style files.

alias: v

enum: Emulated Native None ShadowDom

description: Specifies the view encapsulation strategy.

description: Flag to skip the module import.

description: The selector to use for the component.

description: Specifies if declaring module exports the component.

alias: b

description: Specifies if the style will contain `:host { display: block; }`.

description: When true, does not create test files.

alias: t

description: Specifies if the template will be in the ts file.

default: Default

alias: c

enum: Default OnPush

description: Specifies the change detection strategy.

description: Specifies if the component is an entry component of declaring module.

description: Allows for skipping the module import.

description: Specifies if declaring module exports the pipe.

description: When true, does not create test files.

key: schematicOptions


enum: never on-failure on-unhealthy always

key: restartPolicy


key: AppModel


key: TriggerMapItemModel


description: The name of the variant.


description: An object representing override rules for a Singer stream schema

description: An array of entity selection rules in the form '<entity|*>.<attribute|*>'

enum: properties catalog discover state about stream-maps activate-version batch test log-based

description: An object containing Singer stream and property metadata


enum: oauth hidden password date_iso8601 file email integer options object array boolean string

description: The type of value this setting contains

description: Used with `kind: object` to process the keys in a particular way.

description: The name of the setting

description: A URL to the documentation for this plugin

description: A description for what this setting does

examples: The unique account identifier for your Stripe Account

description: A link to documentation on this setting

description: The default value of this setting if not otherwise defined

description: A user friendly label for the setting

description: A protected setting cannot be changed from the UI

description: A phrase to provide additional information on this setting

description: An environment variable that will be initialized with the setting's value whenever the plugin is invoked. This is used to inject environment variables into the plugin's execution context. If the named environment variable is already defined at runtime, Meltano will use the passed value from context instead of the configured value.

description: The name of a Meltano-supported OAuth provider

description: A placeholder value for this setting

description: The defined value of the option.

description: A user friendly label describing the plugin

description: Alternative setting names that can be used in 'meltano.yml' and 'meltano config set'


description: The name of the dialect of the target database, so that transformers in the same pipeline and Meltano UI's Analysis feature can determine the type of database to connect to.

description: The name of the database schema the loader has been configured to load data into (assuming the destination supports schemas), so that transformers in the same pipeline can determine the database schema to load data from.

enum: about stream-maps activate-version batch soft-delete hard-delete datatype-failsafe record-flattening


description: A single plugin requirement

description: The variant of the required plugin

description: The name of the required plugin


required: config name

description: Name of the invokable mappings and their associated configs.


title: Semantic Version

key: semver


description: Environment variable value provided by decoding other values

title: Env Value Mapping

required: source mapping

description: The default value in case no decode mapping was found, if not provided it will default to the source value

title: Env Value

description: The source environment variable (can be an env expression)

title: Env Var

title: Env Value

description: The decoding mapping from one value to another value

title: Value Mapping


description: A potentially optional external makefile to extend

title: External Makefile

description: The path of the external makefile, relative to this file

title: File Path

description: If true, the external makefile is optional and does not need to exist

key: extend


title: Script Line

title: Script Lines

title: Script File

file: path/to/script

description: If true, the `file` value is an absolute path

default: path/to/script

description: Scipt file name

title: File Path

description: Script content split to parts to enable a more fine tuned extension capability

title: Split Script

initKeys: pre main post

description: Pre-main script section

title: Pre-Main Script

description: Post-main script section

title: Post-Main Script

description: Main script section

title: Main Script

title: Script

key: script


description: Provide environment variable via script

title: Env Value Script

description: Enable multi-line values

title: Script Lines


description: Environment value holding a list of paths based on given glob definitions

title: Env Value Glob

description: If true, include files in glob

description: The glob used to fetch all paths

title: Glob Pattern

default: git

description: An ignore source that enables respecting ignore files from that source

title: Ignore Source

description: If true, include directories in glob


description: Unsets environment variable

title: Unset

description: If true, the env variable will be unset, else ignored


profile: development

description: The path to the env file

title: File Path

description: The env file path and attributes

default: development

description: The profile name this file is relevant to

examples: development production

title: Profile

description: The path to the env file

title: File Path

default: path/to/dir

description: The path base directory (relative paths are from this base path)

title: Directory Path

description: File containing environment variables and their values

title: Env File

key: envfile


description: The package unique identifier

key: PackageIdentifier


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

key: ProductCode


description: List of commands or aliases to run the package

key: Commands


enum: interactive silent silentWithProgress

title: InstallModes

description: List of supported installer modes

key: InstallModes


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

description: Enumeration of supported installer types

key: InstallerType


description: The package meta-data locale

key: Locale


description: List of protocols the package provides a handler for

key: Protocols


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

key: InstallerSuccessCodes


description: List of file extensions the package could support

key: FileExtensions


description: List of appx or msix installer capabilities

key: Capabilities


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

key: PackageFamilyName


title: Platform

description: The installer supported operating system

key: Platform


enum: install uninstallPrevious

description: The upgrade method

key: UpgradeBehavior


description: The installer minimum operating system version

key: MinimumOSVersion


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

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

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

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

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

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

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

key: InstallerSwitches


enum: user machine

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

key: Scope


description: The package version

key: PackageVersion


description: The distribution channel

key: Channel


description: List of appx or msix installer restricted capabilities

key: RestrictedCapabilities


description: The field name of the param to inject values into

description: An optional operationName that will only inject custom values if the name of the operation on the request matches

description: A list of possible values to be randomly selected for the given field

enum: ALL QUERY MUTATION

description: An optional GraphQL operation type (MUTATION or QUERY) that will inject custom values only when the request matches the operation type

key: GraphQLCustomVariable


description: Specifying `TOKEN_PATH` tells HawkScan to extract the token from the JSON payload of the response from authentication. `HEADER` tells HawkScan to extract the token from a header in the response from authentication. defaults to `TOKEN_PATH`.

description:
*Required**. String containing the path to the token in the JSON payload authentication response or the name of the response header containing the token.
Example: if the authentication response JSON payload looks like `{"auth" : {"token": "<my-auth-token>"}}` the value would be `auth.token`. If the authentication response has a header named `AuthToken: <my-token>`, then the value should be `AuthToken`.

key: TokenExtraction


description:
An enum value representing how to pass the authorization token to your application.
`HEADER` indicates that each request should have the authorization token header added to the requests.
`QUERY_PARAM` indicates that the token should be passed as a query parameter.

description: **Required** The name of the `HEADER` or `QUERY_PARAM` the token should be passed as.

key: TokenAuthorization


description: **Required**. The username for proxy credentials

description: Scheme of auth: BASIC, NTLM,

description: **Required**. The password for proxy credentials

description: Realm for proxy credentials

key: ProxyCredentials


key: CustomVariable


key: GraphQLExcludeOperationParam


description: A list of strings that are the names of cookies used for maintaining a session. Typically this is one value like `jsessionid` or `PHPSESS`. When used in combination with authentication HawkScan will use this value to persist authenticated session state with your application.

key: CookieAuthorization


description: List of string header names: the values of HTTP headers matching these names will be redacted from alerts and logs.

description: List of string static values: the values here will be added to the redacted token list. This is best used with ${ENV_VAR:default} interpolation.

key: AppRedactions


description: File path of the Postman collection

description: api key to authenticated the user with Postman

description: Id of the collection to be pulled from Postman

key: PostmanConfig


required: matchString replacement

description: Enable regex search for `matchString`. Useful when `replaceOnly` is true (e.g. `Referer:.*` will replace the entire `Referer:` header line)

description: If false, replace existing header value or add the missing header using replacement as the value. If true, only replace the matchString of an existing header line.

description: If `replaceOnly` is false, only match the header name. If `replaceOnly` is true, matches the exact string on the header line.

key: ReplacerRules


description: Host path to the SOAP WSDL, prefixed with a `/`

description: Relative path to the SOAP WSDL schema definition file

key: SoapConf


description: The field name of the param to inject values into

description: A list of possible values to be randomly selected for the given field

enum: POST PUT DELETE GET OPTIONS PATCH HEAD

description: A list of optional HTTP request methods that will inject custom values only when the request matches one of those methods.

description: An optional path regex that will only inject custom values if the path of the request matches

key: OpenApiCustomVariable


description: The keyword name.

description: An arbitrary value to associate with the keyword.

key: Tag


required: waitTimeoutMillis pollDelay

description: The request content to send along with POST or PUT requests for target verification.

description: The path to a public reachable route in your application. For example `/index`. A `GET` request will be made to this path to confirm the host is up and ready to receive traffic.

type: number string

description: The maximum amount of time in milliseconds that HawkScan will wait for your app to be available before it starts scanning

description: The maximum amount of time in milliseconds in between requests to your application to see if it's running

enum: GET POST PUT

description: Request method to use for queries. Will generate GraphQL queries as either POST payloads or GET uri strings.

key: WaitForAppTarget


description: Name of the scan policy to use. This field is optional and defaults will be selected if omitted

description: Maximum duration that a scan will spend on a rule.

description: Maximum duration that a scan will run.

description: Specify to only run  scan on the listed plugins

description: Number of request threads. _If you need that little extra push._ defaults to 20

description: Pause active scan when passive backlog is greater than this value, resumes once backlog is empty. defaults to 50

description: Delay time between sending requests.

key: ScanConf


description:
Paths to files or directories.

It should be an array of strings. Each element of the array should be a path to a file or directory.

If the `--clean` flag is provided to `zinoma`, the files or directories specified in `paths` will be deleted before running the build flow.

__Example__

```yaml targets: npm_install: input: - paths: [package.json, package-lock.json] output: - paths: [node_modules] build: npm install ```

In this example, as the target specifies an `input`, `zinoma npm_install` is incremental. The script `npm install` will be skipped until `package.json`, `package-lock.json` or `node_modules` are modified.

Additionally:

- the command `zinoma --clean` will delete `node_modules`; - the command `zinoma --clean npm_install` will delete `node_modules`, then run `npm install`.

description:
Filter files resource by file extensions.

It should be an array of strings.

If `extensions` are specified, only files matching at least one of the extensions will be included in the resource.

__Example__

```yaml targets: protoc: input: - paths: [protos] extensions: [proto] output: - paths: [protos] extensions: [go] build: | cd protos docker run -v `pwd`:/defs namely/protoc-all -d . -o . -l go

description:
Shell script whose output identifies the state of a resource.

It should be a string.

__Example__

```yaml targets: build_docker_image: input: - paths: [Dockerfile, src] - cmd_stdout: 'docker image ls base:latest --format "{{.ID}}"' output: - cmd_stdout: 'docker image ls webapp:latest --format "{{.ID}}"' build: docker build -t webapp . ```

key: OutputResource


description:
Output resources of another target.

It should be a string with the format `<project_name>::<target_name>.output`. If the other target is located in the same project, the project name can be skipped. The `input` would then have this format: `<target_name>.output`.

When such an input is used:

- all the output resources of the other target become input resources for this target; - the other target implicitly becomes a dependency to this target.

__Example__

```yaml targets: node_dependencies: input: - paths: [package.json, package-lock.json] output: - paths: [node_modules] build: npm install

compile: input: - node_dependencies.output - paths: [package.json, tsconfig.json, src] output: - paths: [dist] build: tsc

run: input: - node_dependencies.output - paths: [package.json] - compile.output service: node dist/index.js ```

description:
Paths to files or directories.

It should be an array of strings.

Each element of the array should be a path to a file or directory.

__Example__

```yaml targets: npm_install: input: - paths: [package.json, package-lock.json] output: - paths: [node_modules] build: npm install ```

description:
Filter files resource by file extensions.

It should be an array of strings.

If `extensions` are specified, only files matching at least one of the extensions will be included in the resource.

__Example__

```yaml targets: fmt: input: - paths: [src, tests] extensions: [rs] build: exec cargo fmt --all -- --check

key: InputResource


description:
List of [`targets`] that must complete successfully before this target can be built.

[`targets`]: enum.Target.html

It should be an array of strings.

If any of the dependencies fails to complete, this target will not be executed.

__Example__

```yaml targets: target1: dependencies: [] target2: dependencies: [target1] target3: dependencies: [target2] ```

In this example, `target1` must complete successfully before `target2` begins, while `target3` waits for `target2` to complete.

`zinoma target2` will run sequentially `target1` and `target2`.

`zinoma target3` will run sequentially `target1`, `target2` and `target3`.

key: Dependencies


description: The name of the table

key: tableName


description: Drops all foreign key constraints for a table.

description: Name of the table containing columns constrained by foreign keys

description: Schema name of the table containing columns constrained by foreign keys

description: Catalog name of the table containing columns constrained by foreign keys

key: dropAllForeignKeyConstraints


description: The comments stored for the table/view/column

key: remarks


description: Creates a lookup table containing values stored in a column and creates a foreign key to the new table.

required: existingColumnName existingTableName newColumnName newTableName

description: Name of the foreign-key constraint to create between the existing table and the lookup table

description: Name of the column in the new table to create

description: Name of the table containing the data to extract

description: Data type of the new table column

description: Name of lookup table to create

key: addLookupTable


description: The name of the catalog

key: catalogName


description: Specifies logical expression of database type(s) on which the change must be applied. Valid database type names are listed on the supported databases page. It can be a comma-separated list of multiple databases or you can also specify that a change is not applicable to a particular database type by prefixing with !. The keywords all and none are also available.

key: dbms


description: Name of the sequence which next value is used

description: Name of the sequence which current value is used

type: number

description: integer value of the attribute.

description:
Value of the attribute.
Note: If not set, then the first valueXXX defined is used in the order they appear.

description: boolean value of the attribute.

description: Date and/or Time value to set the attribute to. The value shall be specified in one of the following forms: "YYYY-MM-DD", "hh:mm:ss" or "YYYY-MM-DDThh:mm:ss".

description: A value that is returned from a function or procedure call. This attribute shall contain the function name to call.

key: whereParams


description: The name of the schema

key: schemaName


description: empty

key: empty


description: Drops an existing foreign key.

required: baseTableName constraintName

description: Name of the table containing the column constrained by the foreign key

description: Name of the foreign key constraint to drop

key: dropForeignKeyConstraint


description: Logs a message and continues execution.

description: Message to output

default: STDERR

enum: STDOUT STDERR FATAL WARN INFO DEBUG

description: Target for message. Possible values: STDOUT, STDERR, FATAL, WARN, INFO, DEBUG. Default value: STDERR

key: output


description: The executeCommand Change Type executes a system command.

description: The name of the executable to run

description: The value of the attribute (for example: '-param')

description: Arguments for the executable

description: The list of operating systems on which to execute the command (taken from the os.name Java system property)

description: The timeout value for executable to run

description: Arguments for the executable

key: executeCommand


description: Stops Liquibase execution with a message. Mainly useful for debugging and stepping through a changelog

description: Message to output when execution stops

key: stop


description: Adds a foreign key constraint to an existing column.

required: baseColumnNames baseTableName constraintName referencedColumnNames referencedTableName

description: ON UPDATE functionality. Possible values: 'CASCADE', 'SET NULL', 'SET DEFAULT', 'RESTRICT', 'NO ACTION'

description: Schema name of the base table

description: Is the foreign key initially deferred

description: Schema name of the referenced table

description: Catalog name of the base table

description: ON DELETE functionality. Possible values: 'CASCADE', 'SET NULL', 'SET DEFAULT', 'RESTRICT', 'NO ACTION'

description: Schema name of the referenced table

description: Name of the new foreign key constraint

description: Is the foreign key deferrable

description: Name of the table the foreign key points to

description: Name of column(s) to place the foreign key constraint on. Comma-separate if multiple

description: Name of the table containing the column to constraint

description: Shall be true if the foreign key should 'ENABLE VALIDATE' set, or false if the foreign key should 'ENABLE NOVALIDATE' set.

description: Column(s) the foreign key points to. Comma-separate if multiple

key: addForeignKeyConstraint


description: The tagDatabase Change Type applies a tag to the database for future update or rollback.

description: The tag to apply

key: tagDatabase


description:
The path to a file, whose contents will be written as a CLOB (i.e. chunk of character data).
The path to the changelog file location must be either absolute or relative. An example of an absolute path is: /usr/local/somefile.dat on Unix or c:\Directory\somefile.dat on Windows.

description: The attribute which is used if the value in name isn't actually a column name but a function. Since 3.3.0

description: The name of the encoding (specified in java.nio.Charset javadoc, e.g. "UTF-8") of the CLOB file (specified in valueClobFile) contents.

description: The attribute that allows you to control where in the table column order the new column goes if it is used in an addColumn command. Only one of beforeColumn, afterColumn, or position is allowed. Since 3.1

description: Name of the column in the CSV file from which the value for the column will be taken if its different from the column name. Ignored if index is also defined.

description: The default value that is returned from a function or procedure call. This attribute will contain the function to call.

description: The default boolean value for column.

description: Index of the column in the CSV file from which the value for the column will be taken.

description: The numeric value to set the column to. The value will not be escaped and will not be nested in quote marks.

description: The default value for column.

description: The value of each step by auto-increment. Ignored on databases that do not support autoincrement/identity functionality.

description: The boolean value to set the column to. The actual value string inserted will depend on the database implementation.

description: The column data type.

description: The default date and time value for column. The value is specified in one of the following forms: YYYY-MM-DD, hh:mm:ss, or YYYY-MM-DDThh:mm:ss.

description: The name of the sequence in which the next value is used.

description: The auto-increment column. Ignored on databases that do not support the autoincrement/identity functionality.

description: The default numeric value for column.

description:
The path to a file, whose contents will be written as a BLOB (i.e. chunk of binary data).

The path to the changelog file location must be either absolute or relative. An example of an absolute path is: /usr/local/somefile.dat on Unix or c:\Directory\somefile.dat on Windows.

description: The boolean attribute which allows you to specify that a column should be used in a descending order in the index if it is used in a createIndex command. Default value is false (in an ascending order) Since 3.4

description: The date and time value to set the column to. The value is specified in one of the following forms: YYYY-MM-DD, hh:mm:ss, or YYYY-MM-DDThh:mm:ss.

description: A short description of the column (column comment).

description: The value auto-increment start. Ignored on databases that do not support autoincrement/identity functionality.

description: The name of the column.

description: The name of the sequence in which the current value is used.

description: The value for which to set the column. The value will be surrounded by quote marks and nested quote marks will be escaped.

description: The attribute that allows you to control where in the table column order the new column goes if it is used in an addColumn command. Only one of beforeColumn, afterColumn, or position is allowed. Uses one based index. Since 3.1

description: Constraint definitions

description: The foreign key name.

description: The attribute that sets delete cascade.

description: The attribute that defines whether constraints are initially deferred.

description: The name of the schema.

description: The attribute that defines whether the column is nullable.

description: The not null constraint name.

description: The attribute that defines whether to validate the defined check constraint.

description: The name of the catalog.

description: The primary key name Since 1.6.

description: The tablespace to use for the defined primary key.

description: The attribute that defines whether to validate the defined foreign key constraint.

description: The attribute that defines whether constraints are deferrable.

description: The attribute that defines whether to validate the defined not null constraint.

description: The foreign key definition.

description: The attribute that defines whether to validate the defined primary key constraint.

description: The unique constraint name.

description: The name of the table.

description: The attribute that defines whether a unique clause should be applied.

description: The name of the column.

description: The attribute that defines whether the column is a primary key.

description: The attribute that defines whether to validate the defined unique constraint.

description: The value that is returned from a function or procedure call. This attribute will contain the function to call.

key: column


description: The customChange type creates a custom Change Type class.

key: customChange


description: Allows to define the 'where' condition(s) string

key: where


description:
Configure the mapping of ports from the public Fly proxy to your application.

You can have:
* **No services section**: The application has no mappings to the external internet - typically apps like databases or background job workers that talk over 6PN private networking to other apps.
* **One services section**: One internal port mapped to one external port on the internet.
* **Multiple services sections**: Map multiple internal ports to multiple external ports.

enum: tcp udp

description: The protocol used to communicate with your application. Can be: `tcp` or `udp`.

description: The port this application listens on to communicate with clients. The default is 8080. We recommend applications use the default.

description:
Health checks that run as one-off commands directly on the VM.

This type of check is **deprecated**. See `tcp_checks` or `http_checks` for alternatives.

description: Control autoscaling metrics (connections or requests) and limits (hard and soft).

default: connections

enumValues: Autoscale based on number of concurrent connections

enumValues: Autoscale based on number of concurrent requests

enum: connections requests

description: When an application instance is __at__ or __over__ this number, the system will bring up another instance.

description: When an application instance is __at__ or __over__ this number, the system is likely to bring up another instance.

description: HTTP-based health checks run against the `internal_port`. These checks will pass when receiving a 2xx response. Any other response is considered a failure.

description: The time to wait after a VM starts before checking its health. Units are milliseconds unless you specify them like `10s` or `1m`.

enum: http https

description: The protocol to be used (`http` or `https`)

description: When set to `true` (and `protocol` is set to `https`), skip verifying the certificates sent by the server.

description: The number of consecutive check failures to allow before attempting to restart the VM. The default is `0`, which disables restarts based on failed health checks.

description: Length of the pause between connectivity checks. Units are milliseconds unless you specify them like `10s` or `1m`.

description: Set key/value pairs of HTTP headers to pass along with the check request.

description: The maximum time a connection can take before being reported as failing its healthcheck. Units are milliseconds unless you specify them like `10s` or `1m`.

description: The path of the URL to be requested.

description: The HTTP method to be used for the check.

description: Basic TCP connection health checks. This is the default check that runs against the configured `internal_port`.

description: The number of consecutive TCP check failures to allow before attempting to restart the VM. The default is `0`, which disables restarts based on failed TCP health checks.

description: Force HTTP connections to HTTPS. `force_https` requires the `http` handler in the `handlers` section.

description: The port to accept traffic on. Valid ports: 1-65535

description:
An array of strings that select handlers to terminate the connection at the edge.

Valid options: http, tls, proxy_proto, pg_tls, edge_http.

description: For each external port you want to accept connections on, add a `ports` section.

key: services


description: The path inside your container where the assets to serve are located.

description: The URL prefix that should serve the static assets.

key: statics


title: Body

title: Action

enum: lock unlock

title: Locking

title: Lock Reason

key: labelItem


enum: ignore object package

key: NamespaceStrategy


required: name query average_value

key: AutoscalingMetrics


required: port service

key: GRPCAction


required: Type IntVal StrVal

key: IntOrString


description: pass OIDC IDToken to upstream via Authorization Bearer header

description: bypass authentication for requests that match the method & path. Format: method=path_regex OR path_regex alone for all methods

description: skip requests that have verified JWT bearer tokens

key: SSOProxy


required: name type application

key: ClientOf


enum: preview go-live active maintenance eol

description: An enumeration describing the different support phases of a product

$comment: If we targeted draft-06 we could use oneOf/const in combination to add descriptions to the enum values

key: supportPhase


description: A SemVer-compatible version string

key: releaseVersion


enum: sts lts

description: An enumeration describing the different releaes types of a product

key: releaseType


$comment: If we targeted draft-07 we could use the 'date' format instead of this format pattern. We cannot use the 'date-time' format because our existing values don't validate against it.

description: A date in the format YYYY-MM-DD

key: dateYYYYMMDD


format: duration

key: healthcheck


type: string number boolean null


description: The end time of a scheduled job. Example. 2014-06-12T00:00:00-08:00

format: date-time

description: The name of the Azure Webjob.

enum: Second Minute Hour Day Week Month

description: The frequency metric used with the 'interval' property.

description: The start time of a scheduled job. Example. 2014-06-11T00:00:00-08:00

description: The interval of how often the Azure Webjob should run. Use it with the 'jobRecurrenceFrequency' property.

key: shared


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

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

title: Database user

key: DependencyDatabaseUser


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

title: DNS defaults

key: DefaultDNS


title: Plugin

key: Plugin


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

title: Secrets

key: Secrets


description: Target full url.

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

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

title: Monitoring target

key: MonitoringTarget


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

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

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

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

title: Storage CORS

key: DependencyStorageCORS


title: Deploy

key: DependencyDeploy


description: Public key value in PEM format.

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

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

description: Private key value in PEM format.

title: SSL

key: SSL


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

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

title: State

key: State


required: type token channel

description: Bot user oauth token used for slack notification.

description: Channel used for slack notification.

const: slack

required: type email

description: Email used for email channel type.

const: email

title: Monitoring channels

enum: slack email

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

key: MonitoringChannel


title: Run

key: DependencyRun


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

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

title: Run defaults

key: DefaultRun


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

title: Deploy defaults

key: DefaultDeploy


description: Restart on vcap-services env change

description: Restart on user-provided env change

description: Restart on vcap-application env change

key: module-parameters-restart-on-env-change


description: The username is optional, but if a Docker image from a private repository is uploaded, then it is mandatory.

description: An image parameter is a docker image from the Docker Hub or somewhere else. eg. cloudfoundry/test-app

description: The password is optional, but if a Docker image from a private repository is uploaded, then it is mandatory.

key: module-parameters-docker


description: Specify that the resource would be used as a target for the module content deployment.

key: module-requires-parameters


description: Keep the existing routes

description: Keep the existing Service bindings

description: Keep the existing environment

key: module-parameters-keep-existing


key: module-parameters-routes


description: The org in which the configuration will be looked for

description: The space in which the configuration will be looked for

key: resource-configuration-target


description: URL to which logs for bound applications are streamed.

description: The service plan.

description: The configuration parameters which will be passed to the service broker.

description: The custom tags for a service instance.

key: resource-skip-service-updates


description: Default value is false.

description: Default value is true.

key: properties-metadata


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

key: color


title: Extension dependency

key: dependency


title: Machine name


title: Override-Checkout

title: Name

title: RequiredProjectModel

key: RequiredProjectModel


title: Zuul

title: ZuulRoleModel

key: ZuulRoleModel


title: Queue

title: Jobs

title: PipelineModel

key: PipelineModel


required: name secret

title: Secret

title: Name

title: Pass-To-Parent

title: JobSecretModel

key: JobSecretModel


required: name data

title: Data

title: Name

title: SecretModel

key: SecretModel


title: Soft

title: Name

title: JobDependencyModel

key: JobDependencyModel


description: The transformation value that should be applied.


description: Use JSONPath syntax to navigate to the node where the transform should be applied.


title: Command

description: Command information

examples:
npm run test
echo "This is a custom command"

title: Bash command to run

enum: root workspace

examples: root workspace

title: Folder where to run the command

Description: If command fails, continue MegaLinter process or not

title: Continue if failed


enum: all_flavors all ci_light cupcake documentation dotnet dotnetweb go java javascript php python ruby rust salesforce security swift terraform


description: Only for the 'pre-commit' hooks, this automatically calls 'git add' after running the command or script.

key: StageFixed


description: Specify tags for commands and scripts, useful for excluding

key: Tags


description: Skip all or specific commands and scripts

key: Skip


description: Force the command, script, or hook to execute only in certain conditions. This acts like the opposite of skip.

key: Only


description: Specify environment variables for the command or script.

key: Env


description: Text to show when the command or script fails.

key: FailText


description: Whether to use interactive mode and provide a STDIN for a command or script.

key: Interactive


description: The path to the folder that must be stored as an output artifact

title: Path

description: Must be set to `true` if the artifact files must be saved in real-time

title: Mount

title: Artifact

key: Artifact


description: An enumeration.

title: PythonVersion

key: PythonVersion


title: Container Port

title: Local Port

title: PortMapping

key: PortMapping


description: Username

title: Username

description: Password or access token

title: Password

title: RegistryAuth

key: RegistryAuth


description: Spec directory path relative to the current working dir when jasmine is executed.

description: Array of filepaths (and globs) relative to spec_dir to include and exclude.

description: Array of filepaths (and globs) relative to spec_dir to include before jasmine specs

key: root-items


description: Configuration of the Jasmine environment

description: Whether to fail the spec if it ran no expectations. By default a spec that ran no expectations is reported as passed. Setting this to true will report such spec as a failure.

description: Whether to randomize spec execution order.

description: Whether to stop execution of the suite after the first spec failure.

description: Clean closures when a suite is done running (done by clearing the stored function reference). This prevents memory leaks, but you won't be able to run jasmine multiple times.

description: Whether or not reporters should hide disabled specs from their output. Currently only supported by Jasmine's HTMLReporter.

description: Whether to cause specs to only have one expectation failure.

description: Seed to use as the basis of randomization. Null causes the seed to be determined randomly at the start of execution.

description: Whether or not to issue warnings for certain deprecated functionality every time it's used. If not set or set to false, deprecation warnings for methods that tend to be called frequently will be issued only once or otherwise throttled to to prevent the suite output from being flooded with warnings.

key: env-items


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

key: abstract


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

key: exclusive-contributions


description: Language in which JavaScript objects types are specified.

key: js-types-syntax


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

key: pattern


enum: html markdown none

description: Markup language in which descriptions are formatted.

key: description-markup


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

key: virtual


enum: lowest low normal high highest

key: priority


required: file offset

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

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

description: Name of the exported symbol.

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

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

key: source


description: Name of the symbol to import

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

key: type-reference


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

key: description-sections


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

key: description


description: Relative path to the icon representing the symbol.

key: icon


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

key: extension


description: Link to online documentation.

key: doc-url


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

key: name-converter


key: reference-with-props


description:
A file path to your GraphQL Schema
If you provide a path to a code file(js or ts),
other options will be ignored and the schema exported from the file will be used directly.

title: GraphQLHandlerCodeFirstConfiguration

key: GraphQLHandlerCodeFirstConfiguration


description: Any of: Boolean, JSON

title: FilterHelperArgsOpts

key: FilterHelperArgsOpts


required: field type path

description: Did you use Sample? Provide the response sample path.

description:
Mapping the JSON Schema and define the arguments of the operation.

# Example:
argTypeMap:
  user_id:
    type: string

description:
Your chance to describe the operation!
Make sure the description is clear and concise.

description:
Expose response details done to the upstream API
When you enable this, you will see a new field in the response type;
```graphql
type MyResponseType {
  myFooField: String
  _response: ResponseMetadata
}

# And a new type for the response metadata object
type ResponseMetadata {
  url: URL
  status: Int
  method: String
  headers: JSON
  body: String
}
```

description: Inset any name for the type of the response body.

description: Your chance to provide request schema name.

description:
JSON object representing the mapping of query search parameters (added to the route path) and the matching argument.

# Example:
queryParamArgMap:
  id: user_id

description:
You can define your response schemas by status codes;
```yaml filename=".meshrc.yaml"
responseByStatusCode:
  200:
    responseSchema: ./someschema.json#/somepath
  404:
    responseSample: ./error-sample.json
    responseTypeName: MyError
```

description:
If true, this operation cannot have requestSchema or requestSample
And the request body will be passed as binary with its mime type
unless you define an explicit Content-Type header

description:
This Field based on the field name of the URL path.
Example: "https://MyAPIURL.com/FieldNameHere/",
so we will set the "field: FieldNameHere".

description:
The path definition of the JSON Schema sample.
Example: "./jsons/questions.response.json".

description:
This body will be merged with the request body sent with
the underlying HTTP request

description: Inset any name for the type of the request body.

enum: Query Mutation Subscription

description: Type field is set the opertion type: Query, Mutation or Subscription. (Allowed values: Query, Mutation, Subscription)

enum: GET HEAD POST PUT DELETE CONNECT OPTIONS TRACE PATCH

description: Allowed values: GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH

description: Yay! Now you can provide the response schema name.

title: JsonSchemaHTTPOperation

key: JsonSchemaHTTPOperation


title: RenameConfig

key: RenameConfig


description:
You need configure the arguments for that field;
```yaml
args:
  someArg: "{root.someKeyValue}"
```

description: Name of root field name that resolves the reference

title: ResolveReferenceObject

key: ResolveReferenceObject


title: SortHelperArgsOpts

key: SortHelperArgsOpts


required: graphqlEndpoint applicationUrl

description:
Address of your own GraphQL Hive application

Used by token info to generate a link to the organization, project and target.

description:
Point to your own instance of GraphQL Hive Usage API

Used by usage reporting.

description:
Point to your own instance of GraphQL Hive API

Used by schema reporting and token info.

title: HiveSelfHostingOptions

key: HiveSelfHostingOptions


required: type field max ttl identifier

description: The field of the type that the rate limit is applied to

description: The time period in which the rate limit is applied

description: The type name that the following field belongs to

description: The identifier expression that determines the identity of the request (e.g. `{context.req.socket.remoteAddress}`)

description: The maximum number of requests that can be made in a given time period

title: RateLimitTransformConfig

key: RateLimitTransformConfig


title: LimitHelperArgsOpts

key: LimitHelperArgsOpts


required: type fieldName

enum: query mutation Query Mutation

description: Allowed values: query, mutation, Query, Mutation

title: OASSelectQueryOrMutationFieldConfig

key: OASSelectQueryOrMutationFieldConfig


title: FederationObjectKeyConfig

key: FederationObjectKeyConfig


description:
A file path to your Supergraph Schema
If you provide a path to a code file(js or ts),
other options will be ignored and the schema exported from the file will be used directly.

title: SupergraphHandler

key: SupergraphHandler


title: RedisConfig

key: RedisConfig


title: FederationFieldRequiresConfig

key: FederationFieldRequiresConfig


enum: WEBSQL INDEXEDDB LOCALSTORAGE

description: Allowed values: WEBSQL, INDEXEDDB, LOCALSTORAGE

title: LocalforageConfig

key: LocalforageConfig


description: Any of: Boolean, String

description: Any of: Boolean, String

description: Any of: Boolean, String

description: Any of: Boolean, String

description: Any of: Boolean, String

description: Any of: Boolean, String

description: Any of: Boolean, String

description: Any of: Boolean, String

description: Any of: Boolean, String

description: Any of: Boolean, String

description:
The path to the metrics endpoint
default: `/metrics`

description: Any of: Boolean, String

description: Any of: Boolean, String

title: PrometheusConfig

key: PrometheusConfig


title: ComputedAnnotation

key: ComputedAnnotation


title: KeyAnnotation

key: KeyAnnotation


required: author commit

description: Commit SHA hash (or any identifier) related to the schema version

description: Author of current version of the schema

title: HiveReportingOptions

key: HiveReportingOptions


description:
Specifies the name of a field to pick off origin objects as the key value. When omitted, a `@key` directive must be included on the return type's definition to be built into an object key.
https://www.graphql-tools.com/docs/stitch-directives-sdl#object-keys

description:
Advanced use only; This argument specifies a string expression that allows more customization of the input arguments. Rules for evaluation of this argument are as follows:
  - basic object parsing of the input key: `"arg1: $key.arg1, arg2: $key.arg2"`
  - any expression enclosed by double brackets will be evaluated once for each of the requested keys, and then sent as a list: `"input: { keys: [[$key]] }"`
  - selections from the key can be referenced by using the $ sign and dot notation: `"upcs: [[$key.upc]]"`, so that `$key.upc` refers to the `upc` field of the key.

description:
Specifies a string of additional keys and values to apply to other arguments,
formatted as `\"\"\" arg1: "value", arg2: "value" \"\"\"`.

description: Advanced use only; Allows building a custom key just for the argument from the selectionSet included by the `@key` directive.

description: Specifies which field argument receives the merge key. This may be omitted for fields with only one argument where the recipient can be inferred.

title: MergedRootFieldConfig

key: MergedRootFieldConfig


title: GetFromMockStoreConfig

key: GetFromMockStoreConfig


title: RAMLSelectQueryOrMutationFieldConfig

key: RAMLSelectQueryOrMutationFieldConfig


title: LoadOptions

key: LoadOptions


description: List of ignored types

description: Changes root types and changes the field names (default: false)

description: Changes types (default: true)

enum: bare wrap

description: Specify to apply prefix transform to bare schema or by wrapping original schema (Allowed values: bare, wrap)

description: The prefix to apply to the schema types. By default it's the API name.

title: PrefixTransformConfig

key: PrefixTransformConfig


description: Specify to apply filter-schema transforms to bare schema or by wrapping original schema (Allowed values: bare, wrap)

description: Array of filter rules

title: FilterSchemaTransform

key: FilterSchemaTransform


description:
The name of the Workers KV namespace to use for caching.

Make sure you have configured the following namespace described in [here](https://developers.cloudflare.com/workers/wrangler/cli-wrangler/commands/#kv).

title: CFWorkersKVCacheConfig

key: CFWorkersKVCacheConfig


required: hostName port serviceName idl

enum: binary compact json

description: Name of the Thrift protocol type to use. Defaults to 'binary'. (Allowed values: binary, compact, json)

description: The name of the host to connect to.

description: Path to IDL file

description: The name of your service. Used for logging.

description: Boolean value indicating whether to use https. Defaults to false.

description: If you are using a remote URL endpoint to fetch your schema, you can set headers for the HTTP request to fetch your schema.

description: The path on which the Thrift service is listening. Defaults to '/thrift'.

description: The port number to attach to on the host.

description: JSON object representing the Headers to add to the runtime of the API calls

title: ThriftHandler

key: ThriftHandler


required: selectionSet value

title: GraphQLHandlerhighestValueStrategyConfig


title: RecordHelperArgsOpts

key: RecordHelperArgsOpts


required: field type pubsubTopic

description:
This body will be merged with the request body sent with
the underlying HTTP request

description: Allowed values: Query, Mutation, Subscription

title: JsonSchemaPubSubOperation

key: JsonSchemaPubSubOperation


required: fieldName filterArgs

description: Match fields based on argument, needs to implement `(arg: GraphQLArgument) => boolean`;

description: Field name

title: HoistFieldTransformFieldPathConfigObject


title: UpdateMockStoreConfig

key: UpdateMockStoreConfig


required: sourceName sourceTypeName sourceFieldName keyField keysArg targetTypeName targetFieldName

description:
If return types don't match,
you can specify a result type to apply inline fragment

description: Extract specific property from the result

title: AdditionalStitchingBatchResolverObject

key: AdditionalStitchingBatchResolverObject


title: FederationFieldOverrideConfig

key: FederationFieldOverrideConfig


required: apply outputDir

description:
HTTP URL pattern to be applied
For example;
  apply:
      - http://my-remote-api.com/* \<- * will apply this extension to all paths of remote API

description: Path to the directory of the generated snapshot files

description:
Expression for when to activate this extension.
Value can be a valid JS expression string or a boolean (Any of: String, Boolean)

title: SnapshotPluginConfig

key: SnapshotPluginConfig


description: A url to your WSDL or generated SDL with annotations

description:
JSON object representing the Headers to add to the runtime of the API calls only for schema introspection
You can also provide `.js` or `.ts` file path that exports schemaHeaders as an object

description: JSON object representing the Headers to add to the runtime of the API calls only for operation during runtime

title: SoapHandler

key: SoapHandler


title: AdditionalSubscriptionObject

key: AdditionalSubscriptionObject


required: field invalidate

description: Path to the operation that could effect it. In a form: Mutation.something. Note that wildcard is not supported in this field.

title: LiveQueryInvalidation

key: LiveQueryInvalidation


title: FederationFieldProvidesConfig

key: FederationFieldProvidesConfig


title: CorsConfig

key: CorsConfig


description:
When arrays are stringified, by default they are not given explicit indices:
`a=b&a=c&a=d`
You may override this by setting the indices option to true:
`a[0]=b&a[1]=c&a[2]=d`

description:
Even if there is a single item in an array, this option treats them as arrays
(default: false)

enum: indices brackets repeat comma

description:
You can configure how to format arrays in the query strings.

Note: when using arrayFormat set to 'comma', you can also pass the commaRoundTrip option set to true or false, to append [] on single-item arrays, so that they can round trip through a parse. (Allowed values: indices, brackets, repeat, comma)

title: QueryStringOptions

key: QueryStringOptions


title: FederationFieldTagConfig

key: FederationFieldTagConfig


title: SerializeHeadersConfig

key: SerializeHeadersConfig


description: Default: true

description: Path to your CA

title: MySQLSSLOptions

key: MySQLSSLOptions


title: PubSubConfig

key: PubSubConfig


required: type field

title: ReplaceFieldConfig

key: ReplaceFieldConfig


enum: camelCase capitalCase constantCase dotCase headerCase noCase paramCase pascalCase pathCase sentenceCase snakeCase upperCase lowerCase

description: Allowed values: camelCase, capitalCase, constantCase, dotCase, headerCase, noCase, paramCase, pascalCase, pathCase, sentenceCase, snakeCase, upperCase, lowerCase

description: Specify to apply naming-convention transforms to bare schema or by wrapping original schema (Allowed values: bare, wrap)

title: NamingConventionTransformConfig

key: NamingConventionTransformConfig


title: GenerateOperationsConfig

key: GenerateOperationsConfig


title: PaginationResolverOpts

key: PaginationResolverOpts


description:
A url or file path to your remote GraphQL endpoint.
If you provide a path to a code file(js or ts),
other options will be ignored and the schema exported from the file will be used directly.

description: JSON object representing the Headers to add to the runtime of the API calls only for schema introspection

description:
JSON object representing the `connectionParams` from a WebSocket connection to add to the runtime of the API calls only for operation during runtime.
More information about the WebSocket `connectionParams`:
  - When using `subscriptionsProtocol=WS` (graphql-ws): https://github.com/enisdenjo/graphql-ws/blob/master/docs/interfaces/client.ClientOptions.md#connectionparams
  - When using `subscriptionsProtocol=LEGACY_WS` (subscriptions-transport-ws): https://github.com/apollographql/subscriptions-transport-ws/blob/51270cc7dbaf09c7b9aa67368f1de58148c7d334/README.md#subscriptionclient

description: Enable/Disable automatic query batching

description: Path to a custom W3 Compatible WebSocket Implementation

description:
Path to the introspection
You can separately give schema introspection or SDL

description: Retry attempts if fails

description: URL to your endpoint serving all subscription queries for this source

description: Timeout in milliseconds

enum: SSE WS LEGACY_WS

description:
SSE - Server Sent Events
WS - New graphql-ws
LEGACY_WS - Legacy subscriptions-transport-ws (Allowed values: SSE, WS, LEGACY_WS)

description: Use HTTP GET for Query operations

enum: omit include

description:
Request Credentials if your environment supports it.
[See more](https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials)

@default "same-origin" (Allowed values: omit, include)

enum: GET POST

description: HTTP method used for GraphQL operations (Allowed values: GET, POST)

title: GraphQLHandlerHTTPConfiguration

key: GraphQLHandlerHTTPConfiguration


title: URLPatternObj

key: URLPatternObj


description: Base URL for OData API

description: Headers to be used with the $metadata requests

enum: multipart json

description: Enable batching (Allowed values: multipart, json)

description: Use $expand for navigation props instead of seperate HTTP requests (Default: false)

description: Custom $metadata File or URL

description: Headers to be used with the operation requests

title: ODataHandler

key: ODataHandler


description: Pointer to your SQLite database

description: Path to the SQL Dump file if you want to build a in-memory database

title: TuqlHandler

key: TuqlHandler


title: FileCacheConfig

key: FileCacheConfig


title: StatsdClientBufferHolder

key: StatsdClientBufferHolder


required: sourceName sourceTypeName sourceFieldName targetTypeName targetFieldName

description:
If return types don't match,
you can specify a result type to apply inline fragment

description: Extract specific property from the result

title: AdditionalStitchingResolverObject

key: AdditionalStitchingResolverObject


required: resolver composer

description:
Path to the composer function
Example: ./src/auth.js#authComposer

description:
The GraphQL Resolver path
Example: Query.users

title: ResolversCompositionTransformObject

key: ResolversCompositionTransformObject


required: endpoint username password

description: Username for basic authentication

description: URL for the Neo4j Instance e.g. neo4j://localhost

description: Specifies database name

description: Provide GraphQL Type Definitions instead of inferring

description: Password for basic authentication

description: Specifies whether relationships should always be included in the type definitions as [relationship](https://grandstack.io/docs/neo4j-graphql-js.html#relationship-types) types, even if the relationships do not have properties.

title: Neo4jHandler


description: Types to skip pruning

description: Set to `true` to skip pruning interfaces that are not implemented by any other types

description: Set to `true` to skip pruning unused types

description: Set to `true` to skip pruning empty unions

description: Set to `true` to skip pruning object types or interfaces with no fields

title: PruneTransformConfig

key: PruneTransformConfig


title: MaskedErrorsPluginConfig

key: MaskedErrorsPluginConfig


description: Cache key to invalidate on successful resolver (no error), see `cacheKey` for list of available options in this field.

description: Path to the operation that could effect it. In a form: Mutation.something. Note that wildcard is not supported in this field.

title: CacheEffectingOperationConfig

key: CacheEffectingOperationConfig


description: default: `false`. When set to `true`, includes the execution result of both delegation and execution

description: default `false`. When set to `true`, includes all the operation variables with their values

description: default `false`. When set to `true`, track resolvers as segments to monitor their performance

description: default `false`. When set to `true`, includes all the arguments passed to resolvers and delegation with their values

description: default `false`. When set to `true` append the names of operation root fields to the transaction name

description: default `false`. When set to `true`, includes the GraphQL document defining the operations and fragments

description:
Allows to set a custom operation name to be used as transaction name and attribute
`extractOperationName: {context.headers['x-operation-name']}`

title: NewrelicConfig

key: NewrelicConfig


description: A file that exports a function which takes context as a paramter and returns postgraphile context options (e.g. "./my-function#pgSettings"). See the [postgraphile docs](https://www.graphile.org/postgraphile/usage-schema/) for more information.

description: Extra Postgraphile Plugins to append

description: Enable GraphQL websocket transport support for subscriptions (default: true)

description: A connection string to your Postgres database

description: Enables live-query support via GraphQL subscriptions (sends updated payload any time nested collections/records change) (default: true)

description: Postgraphile Plugins to skip (e.g. "graphile-build#NodePlugin")

description: An array of strings which specifies the PostgreSQL schemas that PostGraphile will use to create a GraphQL schema. The default schema is the public schema.

description: Extra Postgraphile options that will be added to the postgraphile constructor. It can either be an object or a string pointing to the object's path (e.g. "./my-config#options"). See the [postgraphile docs](https://www.graphile.org/postgraphile/usage-library/) for more information. (Any of: JSON, String)

description: Connection Pool instance or settings or you can provide the path of a code file that exports any of those

title: PostGraphileHandler

key: PostGraphileHandler


required: key cert

title: HTTPSConfig

key: HTTPSConfig


required: from to

enum: move copy

description: Allowed values: move, copy

title: TransferSchemaTransformObject

key: TransferSchemaTransformObject


description:
Extract client version
Example: `{context.headers['x-client-version']}`

description:
Extract client name
Example: `{context.headers['x-client-name']}`

title: HiveClientInfo

key: HiveClientInfo


required: table fields

title: TableField

key: TableField


title: OperationFieldPermission

key: OperationFieldPermission


description: 5 by default

description: Max number of traces to send at once (defaults to 25)

description: Send reports in interval (defaults to 10_000ms)

description: 30s by default

description: 200 by default

title: HiveAgentOptions

key: HiveAgentOptions


required: field args

title: LiveQueryIndexBy

key: LiveQueryIndexBy


required: coordinate ttl

title: ResponseCacheTTLConfig

key: ResponseCacheTTLConfig


title: ComposeWithMongooseFieldsOpts

key: ComposeWithMongooseFieldsOpts


title: ExtendTransform

key: ExtendTransform


title: HTTPDetailsExtensionsConfig

key: HTTPDetailsExtensionsConfig


title: EncapsulateTransformApplyTo

key: EncapsulateTransformApplyTo


title: GrpcCredentialsSsl

key: GrpcCredentialsSsl


$id: #/definitions/certificate

description: An Url match pattern string

description: A list of Url match pattern strings, to identify Urls this certificate can be used for.

description: An object containing path to file certificate, on the file system

description: The path to file containing key for certificate, on the file system

description: The passphrase for the certificate

description: A name for the certificate for user reference

description: An object containing path to file containing private key, on the file system

description: A representation of an ssl certificate

title: Certificate

key: certificate


description: Represents an attribute for any authorization method provided by Postman. For example `username` and `password` are set as auth attributes for Basic Authentication method.

title: Auth

$id: #/definitions/auth-attribute

key: auth-attribute


$id: #/definitions/version

required: major minor patch

description: Increment this number if you make changes to the collection that changes its behaviour. E.g: Removing or adding new test scripts. (partly or completely).

description: A human friendly identifier to make sense of the version numbers. E.g: 'beta-3'

description: You should increment this number if you make changes that will not break anything that uses the collection. E.g: removing a folder.

description: Ideally, minor changes to a collection should result in the increment of this number.

description: Postman allows you to version your collections as they grow, and this field holds the version number. While optional, it is recommended that you use this field to its fullest extent!

title: Collection Version

key: version


$id: #/definitions/description

description: The content of the description goes here, as a raw string.

description: Description can have versions associated with it, which should be put in this property.

description:
Holds the mime type of the raw description content. E.g: 'text/markdown' or 'text/html'.
The type is used to correctly render the description when generating documentation, or in the Postman app.

title: Description

description: A Description can be a raw text, or be an object, which holds the description along with its format.

key: description


description: Using the Proxy, you can configure your custom proxy into the postman for particular url match

title: Proxy Config

$id: #/definitions/proxy-config

description: The tunneling details for the proxy config

description: When set to true, ignores this proxy configuration entity

description: The proxy server host

description: The proxy server port

description: The Url match for which the proxy config is defined

key: proxy-config


description: A Cookie, that follows the [Google Chrome format](https://developer.chrome.com/extensions/cookies)

title: Cookie

$id: #/definitions/cookie

required: domain path

description: The domain for which this cookie is valid.

description: This is the name of the Cookie.

description: When the cookie expires.

description: The value of the Cookie.

description: True if the cookie is a session cookie.

description: True if the cookie is a host-only cookie. (i.e. a request's URL domain must exactly match the domain of the cookie).

description: Custom attributes for a cookie go here, such as the [Priority Field](https://code.google.com/p/chromium/issues/detail?id=232693)

description: The path associated with the Cookie.

description: Indicates if this cookie is HTTP Only. (if True, the cookie is inaccessible to client-side scripts)

description: Indicates if the 'secure' flag is set on the Cookie, meaning that it is transmitted over secure connections only. (typically HTTPS)

key: cookie


$id: #/definitions/protocol-profile-behavior

description: Set of configurations used to alter the usual behavior of sending the request

title: Protocol Profile Behavior

key: protocol-profile-behavior


description: Settings related to borders.

description: Allow users to set custom border colors.

description: Allow users to set custom border widths.

description: Allow users to set custom border styles.

description: Allow users to set custom border radius.

key: settingsPropertiesBorder


description: Settings related to typography.

description: Allow users to set custom font styles.

description: Allow users to set custom text decorations.

description: Enable drop cap.

description: Allow users to set custom font sizes.

description: Allow users to set a global minimum font size boundary in px, rem or em. Custom font sizes below this value will not be clamped, and all calculated minimum font sizes will be, at a minimum, this value.

description: Allow users to set custom a max viewport width in px, rem or em, used to set the maximum size boundary of a fluid font size.

description: Allow users to set a custom min viewport width in px, rem or em, used to set the minimum size boundary of a fluid font size.

description: Enables fluid typography and allows users to set global fluid typography parameters.

description: CSS font-size value, including units.

description: Name of the font size preset, translatable.

description: A max font size for fluid font size calculations in px, rem or em.

description: A min font size for fluid font size calculations in px, rem or em.

description: Specifies the minimum and maximum font size value of a fluid font size. Set to `false` to bypass fluid calculations and use the static `size` value.

description: Kebab-case unique identifier for the font size preset.

description:
Font size presets for the font size selector.
Generates a single class (`.has-{slug}-color`) and custom property (`--wp--preset--font-size--{slug}`) per preset value.

description: Allow users to set the number of text columns.

description: Allow users to set custom font weights.

description: Allow users to set the writing mode.

description: CSS font-family value.

required: fontFamily src

description: Paths or URLs to the font files.

default: normal

description: CSS font-style value.

description: CSS unicode-range value.

description: List of available font weights, separated by a space.

description: CSS font-variant value.

description: CSS size-adjust value.

description: CSS font-feature-settings value.

description: CSS descent-override value.

description: CSS line-gap-override value.

description: CSS font-family value.

default: fallback

enum: auto block fallback swap optional

description: CSS font-display value.

description: CSS ascent-override value.

description: CSS font-variation-settings value.

description: CSS font-stretch value.

description: Array of font-face declarations.

description: Name of the font family preset, translatable.

description: Kebab-case unique identifier for the font family preset.

description:
Font family presets for the font family selector.
Generates a single custom property (`--wp--preset--font-family--{slug}`) per preset value.

description: Allow users to set custom letter spacing.

description: Allow users to set custom line height.

description: Allow users to set custom text transforms.

key: settingsPropertiesTypography


description: Settings related to position.

description: Allow users to set sticky position.

key: settingsPropertiesPosition


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

key: refComplete


description: Settings related to dimensions.

description: Allow users to set custom minimum height.

key: settingsPropertiesDimensions


description: Settings related to behaviors.

description: Allow users to enable/disable lightbox.

key: settingsPropertiesBehaviors


description: Settings related to the lightbox behavior.

enum: fade zoom

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

description: Allow users to enable the lightbox behavior.

key: behaviorsBlocksPropertiesComplete


description: Settings related to shadows.

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

required: name slug shadow

description: CSS box-shadow value

description: Name of the shadow preset, translatable.

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

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

key: settingsPropertiesShadow


description:
Setting that enables the following UI tools:

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

key: settingsPropertiesAppearanceTools


description: Settings related to colors.

required: name slug color

description: CSS hex or rgb(a) string.

description: Name of the color preset, translatable.

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

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

description: Allow users to create custom gradients.

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

description: Allow users to create custom duotone filters.

description: Allow users to set text colors.

description: Allow users to select custom colors.

required: name slug colors

description: CSS hex or rgb string.

description: List of colors from dark to light.

description: Name of the duotone preset, translatable.

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

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

description: Allow users to set link colors.

description: Allow users to set background colors.

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

required: name slug gradient

description: CSS gradient string.

description: Name of the gradient preset, translatable.

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

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

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

key: settingsPropertiesColor


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

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

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


description: Settings related to layout.

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

description: Disable the layout UI controls.

description: Sets the max-width of the content.

key: settingsPropertiesLayout


description: Settings related to spacing.

description:
Settings to auto-generate space size presets for the space size selector.
Generates a custom property (--wp--preset--spacing--{slug}`) per preset value.

description: With + or * depending on whether scale is generated by increment or multiplier.

default: rem

enum: px em rem vh vw %

description: Unit that the scale uses, eg. rem, em, px.

description: Number of steps to generate in scale.

description: The value to medium setting in the scale.

description: The amount to increment each step by.

description: CSS space-size value, including units.

description: Name of the space size preset, translatable.

description: Unique identifier for the space size preset. For best cross theme compatibility these should be in the form '10','20','30','40','50','60', etc. with '50' representing the 'Medium' size step.

description:
Space size presets for the space size selector.
Generates a custom property (`--wp--preset--spacing--{slug}`) per preset value.

description: Allow users to set a custom padding.

description:
Enables `--wp--style--block-gap` to be generated from styles.spacing.blockGap.
A value of `null` instead of `false` further disables layout styles from being generated.

default: px em rem vh vw %

description: List of units the user can use for spacing values.

description: Allow users to set custom space sizes.

description: Allow users to set a custom margin.

key: settingsPropertiesSpacing


title: Label

description: Only issues or pull requests with all of these labels are check if stale.

title: Only Labels

type: string boolean

description: Comment to post when removing the stale label.

title: Unmark Comment

type: integer boolean

description: Number of days of inactivity before an Issue or Pull Request with the stale label is closed.

title: Days Until Close

description: Limit the number of actions per hour.

title: Limit Per Run

description: Number of days of inactivity before an Issue or Pull Request becomes stale.

title: Days Until Stale

default: wontfix

description: Label to use when marking as stale.

title: Stale Label

default: This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

description: Comment to post when marking as stale.

title: Mark Comment

enum: issues pulls

description: Limit to only issues or pulls requests.

title: Only

description: Set to true to ignore issues with an assignee.

title: Exempt Assignees

description: Comment to post when closing a stale issue or pull request.

title: Closed Comment

title: Label

description: Issues or Pull Requests with these labels will never be considered stale.

title: Exempt Labels

description: Set to true to ignore issues in a milestone.

title: Exempt Projects

key: configuration


pattern: ^(true|false)$

key: symbolInfo


description: The name of the existing required dependencies that will be modified.

description: Parameters can be used to influence the behavior of tools which interpret this descriptor. Parameters are not made available to the hook at runtime. Provided property values can be accessed by "~{<provided-property-name>}". Such expressions can be part of an arbitrary string

description: List of the existing required dependencies that will be modified by this extension.

description: The name of the existing hook that will be modified by this extension.

description: Configuration parameters that are used when executing the hook to the target runtime environment.

key: hooks


description: Console command name

title: Command name

key: commands


description: CVar name

title: Variable name

key: cvars


type: string array

description:
A command line script or scripts.

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

key: script


type: string object

default: default

enum: default build

key: dependencies


key: compilationOptions


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

required: name description

Stablecoin

description: A token with value pegged to another asset

description: The name of the tag

description: A user-friendly description of the tag

key: TagDefinition


description: The unique identifier of a tag

examples: compound stablecoin

key: TagIdentifier


description: The name of a token extension property

examples: color is_fee_on_transfer aliases

key: ExtensionIdentifier


key: ExtensionPrimitiveValue


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

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

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

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

key: Version


description: Set to false to not receive a notification when a build fails.

title: Publish on failure

description: Set to false to not receive a notification when a build succeeds.

title: Publish on success

title: PublisherNotification

key: PublisherNotification


errorMessage: Incorrect type. Expected a list of nonempty strings

description: For example, you may consider caching the following paths: "$FLUTTER_ROOT/.pub-cache" for Dart cache, "$HOME/.gradle/caches" for gradle cache, "$HOME/Library/Caches/CocoaPods" for CocoaPods cache.

title: Paths to be cached

title: Cache

key: Cache


enum: MANUAL AFTER_APPROVAL SCHEDULED

description: An enumeration.

title: AppStoreReleaseType

key: AppStoreReleaseType


description: Name of the variable containing the certificate path

title: Environment variable

description: Certificate reference found in Team settings -> Code signing identities

title: Certificate reference

title: CertificateWithVariable

key: CertificateWithVariable


required: credentials track

description: Codemagic supports staged releases, allowing users to choose which fraction of the testers or users get access to the application. To release to everyone, omit the rollout_fraction field.

title: Rollout fraction

description: Codemagic enables you to automatically publish your app to Google Play.

title: Name of the track

description: If your application supports in-app updates, set the release priority by specifying an integer in range [0, 5]. Otherwise, in_app_update_priority can be omitted.

title: Priority of the release

description: Indicates that the changes in this edit will not be reviewed until they are explicitly sent for review from the Google Play Console UI.

title: Do not send changes for review

description: Indicates that the artifacts generated in the build will be uploaded to Google Play as a draft release.

title: Create the release in draft status

description: The encrypted JSON key file or the encrypted contents of the JSON key file. The value can also be passed with an environment variable.

title: Service account credentials

title: GooglePlay

key: GooglePlay


description: The only supported action is to proceed directly to publishing.

title: ScriptOnFailure

key: ScriptOnFailure


enum: aab apk

description: An enumeration.

title: FirebaseAndroidArtifactType

key: FirebaseAndroidArtifactType


description: Directory (tenant) ID in Azure AD portal.

title: Partner Center tenant id

description: Store ID set up on Microsoft Partner Center.

title: Partner Center store ID

description: Application (client) ID in Azure AD portal.

title: Partner Center client id

description: The value of the Azure AD app key.

title: Partner Center client secret

title: PartnerCenter

key: PartnerCenter


errorMessage: Incorrect type. Expected an integer, float, boolean or nonempty string

description: The pattern can also be passed with an environment variable.

title: Exact value or glob pattern to search for a branch

description: If set to false, the matching branches will not be watched for triggering events.

title: Include the pattern

description: The variable is ignored for events other than pull_request.

title: Specify whether the watched branch is the source or the target of the pull request

title: BranchPattern

key: BranchPattern