key: id

description: A variable ID is a unique user-defined value that identifies the variable within a collection. In traditional terms, this would be a variable name.


key: key

description: A variable key is a human friendly value that identifies the variable within a collection. In traditional terms, this would be a variable name.

type: string


key: value

description: The value that a variable holds in this collection. Ultimately, the variables will be replaced by this value, when say running a set of requests from a collection


key: type

description: A variable may have multiple types. This field specifies the type of the variable.

enum: string boolean any number


key: name

description: Variable name


key: system

description: When set to true, indicates that this variable has been set by Postman

type: boolean


key: version

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!

type: object

type: integer

required: major minor patch


key: major

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


key: minor

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


key: patch

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


key: identifier

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


key: author

description: The name of the author of the block


key: blockType

description: The type of block this is (e.g. custom element, React)

enum: custom-element html react


key: commit

description: The commit hash of the source this block was built from. If specified, 'repository' must also be specified.


key: description

description: A short description of the block, to help users understand its capabilities


key: devReloadEndpoint

description: URL of a web socket that reports updates in locally developed blocks. To be used by EAs to auto reload.


key: displayName

description: The display name used for a block


key: examples

description: A list of examples property objects which comply with the block's schema, for demonstration purposes

type: array


key: externals

description: The dependencies a block relies on but expects the embedding application to provide, e.g. { "react": "^18.0.0" }


key: icon

description: An icon for the block, to be displayed when the user is selecting from available blocks (as well as elsewhere as appropriate, e.g. in a website listing the block).


key: image

description: A preview image of the block for users to see it in action before using it. This would ideally have a 3:2 width:height ratio and be a minimum of 900x1170px.


key: license

description: The license the block is made available under (e.g. MIT).


key: name

description: A unique, slugified name for the block.


key: protocol

description: The applicable block protocol version, e.g. 0.3


key: repository

description: Specify the place where your block's code lives. This is helpful for people who want to explore the source, or contribute to your block's development.


key: schema

description: The versioned URL to the block's schema, e.g. https://blockprotocol.org/@blockprotocol/types/entity-type/thing/v/2


key: source

description: The path or URL to the entrypoint source file (e.g. index.html, index.js).


key: variants

description: A list which represents different variants of the block that the user can create.

required: name properties


key: version

description: The version of the block, which should use semantic versioning (@see https://semver.org/).


key: compilationOptions

description: [Deprecated] Options that are passed to the compiler. Use 'buildOptions' instead.

enum: portable full none


key: preserveCompilationContext

description: Set this option to preserve reference assemblies and other context data to allow for runtime compilation


key: buildOptions

description: Options that are passed to the compiler.

default: csc

type: string array object

type: string array


description: Set this option to preserve reference assemblies and other context data to allow for runtime compilation.


key: compile

description: Defines glob patterns and file path to include for compilation.


key: include

description: List of file globbing patterns to be included.


key: exclude

description: List of file globbing patterns to be excluded.


key: includeFiles

description: List of file paths to be included.


key: excludeFiles

description: List of file paths to be excluded.


key: mappings

description: Pairs of destination folders and glob patterns specifying additional files to include/exclude.


key: embed

description: Defines glob patterns and file paths of resource files to include for compilation.


key: copyToOutput

description: Defines glob patterns and file paths to include for copying to build output.


description: Enables/disables server garbage collection.


description: Enables/disables concurrent garbage collection.


description: Limits the number of heaps created by the garbage collector.


description: Specifies the exact processors that garbage collector threads should use.


description: Specifies the list of processors to use for garbage collector threads.


description: Specifies whether to affinitize garbage collection threads with processors. To affinitize a GC thread means that it can only run on its specific CPU. A heap is created for each GC thread.


description: Specifies the maximum commit size, in bytes, for the GC heap and GC bookkeeping.


description: Specifies the GC heap usage as a percentage of the total memory.

type: number


description: Configures whether segments that should be deleted are put on a standby list for future use or are released back to the operating system (OS).


description: Specifies the threshold size, in bytes, that causes objects to go on the large object heap (LOH).


description: Sets the minimum number of threads for the thread pool.


description: Sets the maximum number of threads for the thread pool.


key: packOptions

description: Defines options pertaining to the packaging of the project output into a NuGet package.

default: git

format: uri


key: summary

description: A short description of the package.


key: tags

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


key: owners

description: List of owners of the package.


key: releaseNotes

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


key: iconUrl

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


key: licenseUrl

description: A link to the license for the package.


key: requireLicenseAcceptance

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


key: repository

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


key: files

description: Defines glob patterns and file paths to include in the generated NuGet package.


key: publishOptions

description: Defines glob patterns and file paths to include in publish output.


key: imports

description: Allow packages supporting these frameworks to be installed in this target, regardless of the compatibility rules.


key: dependencies

description: Each dependency is defined by a name and a version. Dependencies are resolved from NuGet feeds defined by your package sources and projects located in the directories specified by the 'global.json' file.

type: string object

default: default

enum: default build platform

enum: project package


key: target

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


key: script

description:
A command line script or scripts.

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


key: authors

description: The author of the application.


key: packInclude

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


key: publishExclude

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


key: compile

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


key: compileExclude

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


key: compileFiles

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


key: content

description: [Deprecated] Glob pattern to specify files to include as content. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'publishOptions' to publish or 'copyToOutput' in 'buildOptions' to copy to build output instead.


key: contentExclude

description: [Deprecated] Glob pattern to specify files to exclude from the content list. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]. Use 'publishOptions' to publish or 'copyToOutput' in 'buildOptions' to copy to build output instead.


key: contentFiles

description: [Deprecated] Files to include as content (overrides 'contentExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]. Use 'publishOptions' to publish or 'copyToOutput' in 'buildOptions' to copy to build output instead.


key: preprocess

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


key: preprocessExclude

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


key: preprocessFiles

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


key: resource

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


key: resourceExclude

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


key: resourceFiles

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


key: shared

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


key: sharedExclude

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


key: sharedFiles

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


key: exclude

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


key: excludeBuiltIn

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

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


key: testRunner

description: The name of the test runner to use with this project


key: configurations

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


key: copyright

description: Copyright details for the package.


key: iconUrl

description: [Deprecated] A URL for the image to use as the icon for the package. This should be a 32x32-pixel .png file that has a transparent background. Use this in 'packOptions' instead.


key: licenseUrl

description: [Deprecated] A link to the license for the package. Use this in 'packOptions' instead.


key: requireLicenseAcceptance

description: [Deprecated] A Boolean value that specifies whether the client needs to ensure that the package license (described by licenseUrl) is accepted before the package is installed. Use this in 'packOptions' instead.


key: owners

description: [Deprecated] List of owners of the package. Use this in 'packOptions' instead.


key: projectUrl

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


key: summary

description: [Deprecated] A short description of the package. Use this in 'packOptions' instead.


key: tags

description: [Deprecated] A space-delimited list of tags and keywords that describe the package. Use this in 'packOptions' instead.


key: title

description: The human-friendly title of the package


key: releaseNotes

description: [Deprecated] A description of the changes made in each release of the package. Use this in 'packOptions' instead.


key: language

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


key: description

description: The description of the project/package.


key: frameworks

description: Target frameworks that will be built, and dependencies that are specific to the build of this project for that framework.


key: namedResource

description: Overrides the generated resource names with custom ones.


key: repository

description: [Deprecated] Contains information about the repository where the project is stored. Use this in 'packOptions' instead.


key: scripts

description: Scripts to execute during the various stages.


key: version

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


key: tools

description: Project-specific command line tools accessible when in the project.json directory.


key: runtimes

description: List of runtime identifiers supported by this project (used when building standalone applications).


key: script

description:
A command line script or scripts.

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


key: publishExclude

description: List of files to exclude from publish output (dnu publish).


key: compile

description: Glob pattern to specify additional code files that needs to be compiled. (data type: string or array with glob pattern(s)). Example: [ "folder1/**/*.cs", "folder2/**/*.cs" ]


key: compileExclude

description: Glob pattern to indicate code files that needs to be excluded from compilation. (data type: string or array with glob pattern(s)). Example: [ "folder1/**/*.cs", "folder2/**/*.cs" ]


key: compileFiles

description: Individual file paths relative to application root that needs to be included for compilation. (data type: string or array). Example: [ "folder1/test1.cs", "folder2/test2.cs" ]


key: compileBuiltIn

description: Glob pattern to indicate the default code files that are included for compilation. (data type: string or array with glob pattern(s)). Example: [ "**/*.cs", "../folder2/**/*.cs" ]


key: exclude

description: Glob pattern to indicate the default files to be excluded from processing. (data type: string or array with glob pattern(s)).


key: excludeBuiltIn

description: Glob pattern to indicate all the additional files to be excluded from processing. (data type: string or array with glob pattern(s)).


key: preprocess

description: Glob pattern to indicate all the code files to be pre-processed. (data type: string or array with glob pattern(s)).


key: preprocessExclude

description: Glob pattern to indicate all the code files to be excluded from pre-processing. (data type: string or array with glob pattern(s)).


key: preprocessFiles

description: Glob pattern to indicate specific code files to be included for pre-processing. (data type: string or array).


key: resource

description: Glob pattern to indicate all the files that need to be compiled as resources. (data type: string or array with glob pattern(s))


key: resourceExclude

description: Glob pattern to indicate files that need to be excluded from being compiled as resources. (data type: string or array with glob pattern(s))


key: resourceFiles

description: Glob pattern to indicate individual files that need to be compiled as resources. (data type: string or array).


key: shared

description: Glob pattern to specify the code files to share with dependent projects. Example: [ "folder1/*.cs", "folder2/*.cs" ]


key: sharedExclude

description: Glob pattern to specify the code files to be excluded from sharing with dependent projects. Example: [ "folder1/*.cs", "folder2/*.cs" ]


key: sharedFiles

description: Glob pattern to specify the individual code files to be shared with dependent projects. Example: [ "folder1/shared1.cs", "folder2/shared2.cs" ]


key: content

description: Glob pattern to specify the files to be considered as content on dnu publish. Example: [ "folder1/**/*" ]


key: contentExclude

description: Glob pattern to specify the files to be excluded from being content on dnu publish. Example: [ "folder1/*.cs", "folder2/*.cs" ]


key: contentFiles

description: Glob pattern to specify the individual files to be content files on dnu publish. Example: [ "folder1/content.cs", "folder2/content2.img" ]


key: configurations

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


key: copyright

description: Copyright details for the package


key: description

description: The description of the application


key: iconUrl

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


key: licenseUrl

description: A link to the license that the package is under


key: projectUrl

description: A URL for the home page of the package


key: scripts

description: Scripts to execute during the various stages.


key: summary

description: A short description of the package


key: title

description: The human-friendly title of the package


key: version

description: The version of the application. Example: 1.2.0.0


key: webroot

description: Specifying the webroot property in the project.json file specifies the web server root (aka public folder). In visual studio, this folder will be used to root IIS. Static files should be put in here.


key: userSecretsId

description: Specify a unique id to manage the development time user secrets of the application


key: cvars

description: CVar name


key: commands

description: Console command name


key: value

description: The default value of the CVar


key: items

description: This indicates where the assets are stored

default: Assets


description: This indicates where the code is stored

default: Code


key: name

description: This indicates the project name


key: engine

description: This indicates which engine version will be used


key: path

description: Required plugin's name

examples: CryDefaultEntities CrySensorSystem CryPerceptionSystem CryUserAnalytics CryOSVR CryOculusVR CryOpenVR CryLobby


key: type

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


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


description: Husky can prevent bad `git commit`, `git push` and more 🐶 woof!

x-intellij-language-injection: Shell Script

x-intellij-html-description:
This hook is invoked by git-am. It takes a single parameter, the name of the file that holds the proposed commit log message. Exiting with a non-zero status causes git am to abort before applying the patch.

The hook is allowed to edit the message file in place, and can be used to normalize the message into some project standard format. It can also be used to refuse the commit after inspecting the message file.

The default applypatch-msg hook, when enabled, runs the commit-msg hook, if the latter is enabled.

x-intellij-html-description:
This hook is invoked by git-am. It takes no parameter, and is invoked after the patch is applied, but before a commit is made.

If it exits with non-zero status, then the working tree will not be committed after applying the patch.

It can be used to inspect the current working tree and refuse to make a commit if it does not pass certain test.

The default pre-applypatch hook, when enabled, runs the pre-commit hook, if the latter is enabled.

x-intellij-html-description:
This hook is invoked by git-am. It takes no parameter, and is invoked after the patch is applied and a commit is made.

This hook is meant primarily for notification, and cannot affect the outcome of git am.

x-intellij-html-description:
This hook is invoked by git-commit, and can be bypassed with the --no-verify option. It takes no parameters, and is invoked before obtaining the proposed commit log message and making a commit. Exiting with a non-zero status from this script causes the git commit command to abort before creating a commit.

The default pre-commit hook, when enabled, catches introduction of lines with trailing whitespaces and aborts the commit when such a line is found.

All the git commit hooks are invoked with the environment variable GIT_EDITOR=: if the command will not bring up an editor to modify the commit message.

The default pre-commit hook, when enabled—and with the hooks.allownonascii config option unset or set to false—prevents the use of non-ASCII filenames.

x-intellij-html-description:
This hook is invoked by git-commit right after preparing the default log message, and before the editor is started.

It takes one to three parameters. The first is the name of the file that contains the commit log message. The second is the source of the commit message, and can be: message (if a -m or -F option was given); template (if a -t option was given or the configuration option commit.template is set); merge (if the commit is a merge or a .git/MERGE_MSG file exists); squash (if a .git/SQUASH_MSG file exists); or commit, followed by a commit SHA-1 (if a -c, -C or --amend option was given).

If the exit status is non-zero, git commit will abort.

The purpose of the hook is to edit the message file in place, and it is not suppressed by the --no-verify option. A non-zero exit means a failure of the hook and aborts the commit. It should not be used as replacement for pre-commit hook.

The sample prepare-commit-msg hook that comes with Git removes the help message found in the commented portion of the commit template.

x-intellij-html-description:
This hook is invoked by git-commit and git-merge, and can be bypassed with the --no-verify option. It takes a single parameter, the name of the file that holds the proposed commit log message. Exiting with a non-zero status causes the command to abort.

The hook is allowed to edit the message file in place, and can be used to normalize the message into some project standard format. It can also be used to refuse the commit after inspecting the message file.

The default commit-msg hook, when enabled, detects duplicate "Signed-off-by" lines, and aborts the commit if one is found.

x-intellij-html-description:
This hook is invoked by git-commit. It takes no parameters, and is invoked after a commit is made.

This hook is meant primarily for notification, and cannot affect the outcome of git commit.

x-intellij-html-description: This hook is called by git-rebase and can be used to prevent a branch from getting rebased. The hook may be called with one or two parameters. The first parameter is the upstream from which the series was forked. The second parameter is the branch being rebased, and is not set when rebasing the current branch.

x-intellij-html-description:
This hook is invoked when a git-checkout or git-switch is run after having updated the worktree. The hook is given three parameters: the ref of the previous HEAD, the ref of the new HEAD (which may or may not have changed), and a flag indicating whether the checkout was a branch checkout (changing branches, flag=1) or a file checkout (retrieving a file from the index, flag=0). This hook cannot affect the outcome of git switch or git checkout.

It is also run after git-clone, unless the --no-checkout (-n) option is used. The first parameter given to the hook is the null-ref, the second the ref of the new HEAD and the flag is always 1. Likewise for git worktree add unless --no-checkout is used.

This hook can be used to perform repository validity checks, auto-display differences from the previous HEAD if different, or set working dir metadata properties.

x-intellij-html-description:
This hook is invoked by git-merge, which happens when a git pull is done on a local repository. The hook takes a single parameter, a status flag specifying whether or not the merge being done was a squash merge. This hook cannot affect the outcome of git merge and is not executed, if the merge failed due to conflicts.

This hook can be used in conjunction with a corresponding pre-commit hook to save and restore any form of metadata associated with the working tree (e.g.: permissions/ownership, ACLS, etc). See contrib/hooks/setgitperms.perl for an example of how to do this.

x-intellij-html-description:
This hook is called by git-push and can be used to prevent a push from taking place. The hook is called with two parameters which provide the name and location of the destination remote, if a named remote is not being used both values will be the same.

Information about what is to be pushed is provided on the hook's standard input with lines of the form:

<local ref> SP <local sha1> SP <remote ref> SP <remote sha1> LF

For instance, if the command git push origin master:foreign were run the hook would receive a line like the following:

refs/heads/master 67890 refs/heads/foreign 12345

although the full, 40-character SHA-1s would be supplied. If the foreign ref does not yet exist the <remote SHA-1> will be 40 0. If a ref is to be deleted, the <local ref> will be supplied as (delete) and the <local SHA-1> will be 40 0. If the local commit was specified by something other than a name which could be expanded (such as HEAD~, or a SHA-1) it will be supplied as it was originally given.

If this hook exits with a non-zero status, git push will abort without pushing anything. Information about why the push is rejected may be sent to the user by writing to standard error.

x-intellij-html-description:
This hook is invoked by git-receive-pack when it reacts to git push and updates reference(s) in its repository. It executes on the remote repository once after all the refs have been updated.

It takes a variable number of parameters, each of which is the name of ref that was actually updated.

This hook is meant primarily for notification, and cannot affect the outcome of git receive-pack.

The post-update hook can tell what are the heads that were pushed, but it does not know what their original and updated values are, so it is a poor place to do log old..new. The post-receive hook does get both original and updated values of the refs. You might consider it instead if you need them.

When enabled, the default post-update hook runs git update-server-info to keep the information used by dumb transports (e.g., HTTP) up to date. If you are publishing a Git repository that is accessible via HTTP, you should probably enable this hook.

Both standard output and standard error output are forwarded to git send-pack on the other end, so you can simply echo messages for the user.

x-intellij-html-description:
This hook is invoked by git-receive-pack when it reacts to git push and updates reference(s) in its repository, and when the push tries to update the branch that is currently checked out and the receive.denyCurrentBranch configuration variable is set to updateInstead. Such a push by default is refused if the working tree and the index of the remote repository has any difference from the currently checked out commit; when both the working tree and the index match the current commit, they are updated to match the newly pushed tip of the branch. This hook is to be used to override the default behaviour.

The hook receives the commit with which the tip of the current branch is going to be updated. It can exit with a non-zero status to refuse the push (when it does so, it must not modify the index or the working tree). Or it can make any necessary changes to the working tree and to the index to bring them to the desired state when the tip of the current branch is updated to the new commit, and exit with a zero status.

For example, the hook can simply run git read-tree -u -m HEAD "$1" in order to emulate git fetch that is run in the reverse direction with git push, as the two-tree form of git read-tree -u -m is essentially the same as git switch or git checkout that switches branches while keeping the local changes in the working tree that do not interfere with the difference between the branches.

x-intellij-html-description: This hook is invoked by git gc --auto (see git-gc). It takes no parameter, and exiting with non-zero status from this script causes the git gc --auto to abort.

x-intellij-html-description:
This hook is invoked by commands that rewrite commits (git-commit when called with --amend and git-rebase; however, full-history (re)writing tools like git-fast-import or git-filter-repo typically do not call it!). Its first argument denotes the command it was invoked by: currently one of amend or rebase. Further command-dependent arguments may be passed in the future.

The hook receives a list of the rewritten commits on stdin, in the format

<old-sha1> SP <new-sha1> [ SP <extra-info> ] LF

The extra-info is again command-dependent. If it is empty, the preceding SP is also omitted. Currently, no commands pass any extra-info.

The hook always runs after the automatic note copying (see "notes.rewrite.<command>" in git-config) has happened, and thus has access to these notes.

The following command-specific comments apply:

rebase

For the squash and fixup operation, all commits that were squashed are listed as being rewritten to the squashed commit. This means that there will be several lines sharing the same new-sha1.

The commits are guaranteed to be listed in the order that they were processed by rebase.

x-intellij-html-description: This hook is invoked by git-send-email. It takes a single parameter, the name of the file that holds the e-mail to be sent. Exiting with a non-zero status causes git send-email to abort before sending any e-mails.

x-intellij-html-description:
This hook is invoked when the configuration option core.fsmonitor is set to .git/hooks/fsmonitor-watchman or .git/hooks/fsmonitor-watchmanv2 depending on the version of the hook to use.

Version 1 takes two arguments, a version (1) and the time in elapsed nanoseconds since midnight, January 1, 1970.

Version 2 takes two arguments, a version (2) and a token that is used for identifying changes since the token. For watchman this would be a clock id. This version must output to stdout the new token followed by a NUL before the list of files.

The hook should output to stdout the list of all files in the working directory that may have changed since the requested time. The logic should be inclusive so that it does not miss any potential changes. The paths should be relative to the root of the working directory and be separated by a single NUL.

It is OK to include files which have not actually changed. All changes including newly-created and deleted files should be included. When files are renamed, both the old and the new name should be included.

Git will limit what files it checks for changes as well as which directories are checked for untracked files based on the path names given.

An optimized way to tell git "all files have changed" is to return the filename /.

The exit status determines whether git will use the data from the hook to limit its search. On error, it will fall back to verifying all files and folders.

x-intellij-html-description: This hook is invoked by git-p4 submit. It takes no parameters and nothing from standard input. Exiting with non-zero status from this script prevent git-p4 submit from launching. Run git-p4 submit --help for details.


key: applypatch-msg

description:
This hook is invoked by git-am. It takes a single parameter, the name of the file that holds the proposed commit log message. Exiting with a non-zero status causes git am to abort before applying the patch.

The hook is allowed to edit the message file in place, and can be used to normalize the message into some project standard format. It can also be used to refuse the commit after inspecting the message file.

The default applypatch-msg hook, when enabled, runs the commit-msg hook, if the latter is enabled.


key: pre-applypatch

description:
This hook is invoked by git-am. It takes no parameter, and is invoked after the patch is applied, but before a commit is made.

If it exits with non-zero status, then the working tree will not be committed after applying the patch.

It can be used to inspect the current working tree and refuse to make a commit if it does not pass certain test.

The default pre-applypatch hook, when enabled, runs the pre-commit hook, if the latter is enabled.


key: post-applypatch

description:
This hook is invoked by git-am. It takes no parameter, and is invoked after the patch is applied and a commit is made.

This hook is meant primarily for notification, and cannot affect the outcome of git am.


key: pre-commit

description:
This hook is invoked by git-commit, and can be bypassed with the --no-verify option. It takes no parameters, and is invoked before obtaining the proposed commit log message and making a commit. Exiting with a non-zero status from this script causes the git commit command to abort before creating a commit.

The default pre-commit hook, when enabled, catches introduction of lines with trailing whitespaces and aborts the commit when such a line is found.

All the git commit hooks are invoked with the environment variable GIT_EDITOR=: if the command will not bring up an editor to modify the commit message.

The default pre-commit hook, when enabled—and with the hooks.allownonascii config option unset or set to false—prevents the use of non-ASCII filenames.


key: prepare-commit-msg

description:
This hook is invoked by git-commit right after preparing the default log message, and before the editor is started.

It takes one to three parameters. The first is the name of the file that contains the commit log message. The second is the source of the commit message, and can be: message (if a -m or -F option was given); template (if a -t option was given or the configuration option commit.template is set); merge (if the commit is a merge or a .git/MERGE_MSG file exists); squash (if a .git/SQUASH_MSG file exists); or commit, followed by a commit SHA-1 (if a -c, -C or --amend option was given).

If the exit status is non-zero, git commit will abort.

The purpose of the hook is to edit the message file in place, and it is not suppressed by the --no-verify option. A non-zero exit means a failure of the hook and aborts the commit. It should not be used as replacement for pre-commit hook.

The sample prepare-commit-msg hook that comes with Git removes the help message found in the commented portion of the commit template.


key: commit-msg

description:
This hook is invoked by git-commit and git-merge, and can be bypassed with the --no-verify option. It takes a single parameter, the name of the file that holds the proposed commit log message. Exiting with a non-zero status causes the command to abort.

The hook is allowed to edit the message file in place, and can be used to normalize the message into some project standard format. It can also be used to refuse the commit after inspecting the message file.

The default commit-msg hook, when enabled, detects duplicate "Signed-off-by" lines, and aborts the commit if one is found.


key: post-commit

description:
This hook is invoked by git-commit. It takes no parameters, and is invoked after a commit is made.

This hook is meant primarily for notification, and cannot affect the outcome of git commit.


key: pre-rebase

description: This hook is called by git-rebase and can be used to prevent a branch from getting rebased. The hook may be called with one or two parameters. The first parameter is the upstream from which the series was forked. The second parameter is the branch being rebased, and is not set when rebasing the current branch.


key: post-checkout

description:
This hook is invoked when a git-checkout or git-switch is run after having updated the worktree. The hook is given three parameters: the ref of the previous HEAD, the ref of the new HEAD (which may or may not have changed), and a flag indicating whether the checkout was a branch checkout (changing branches, flag=1) or a file checkout (retrieving a file from the index, flag=0). This hook cannot affect the outcome of git switch or git checkout.

It is also run after git-clone, unless the --no-checkout (-n) option is used. The first parameter given to the hook is the null-ref, the second the ref of the new HEAD and the flag is always 1. Likewise for git worktree add unless --no-checkout is used.

This hook can be used to perform repository validity checks, auto-display differences from the previous HEAD if different, or set working dir metadata properties.


key: post-merge

description:
This hook is invoked by git-merge, which happens when a git pull is done on a local repository. The hook takes a single parameter, a status flag specifying whether or not the merge being done was a squash merge. This hook cannot affect the outcome of git merge and is not executed, if the merge failed due to conflicts.

This hook can be used in conjunction with a corresponding pre-commit hook to save and restore any form of metadata associated with the working tree (e.g.: permissions/ownership, ACLS, etc). See contrib/hooks/setgitperms.perl for an example of how to do this.


key: pre-push

description:
This hook is called by git-push and can be used to prevent a push from taking place. The hook is called with two parameters which provide the name and location of the destination remote, if a named remote is not being used both values will be the same.

Information about what is to be pushed is provided on the hook's standard input with lines of the form:

<local ref> SP <local sha1> SP <remote ref> SP <remote sha1> LF
For instance, if the command git push origin master:foreign were run the hook would receive a line like the following:

refs/heads/master 67890 refs/heads/foreign 12345
although the full, 40-character SHA-1s would be supplied. If the foreign ref does not yet exist the <remote SHA-1> will be 40 0. If a ref is to be deleted, the <local ref> will be supplied as (delete) and the <local SHA-1> will be 40 0. If the local commit was specified by something other than a name which could be expanded (such as HEAD~, or a SHA-1) it will be supplied as it was originally given.

If this hook exits with a non-zero status, git push will abort without pushing anything. Information about why the push is rejected may be sent to the user by writing to standard error.


key: post-update

description:
This hook is invoked by git-receive-pack when it reacts to git push and updates reference(s) in its repository. It executes on the remote repository once after all the refs have been updated.

It takes a variable number of parameters, each of which is the name of ref that was actually updated.

This hook is meant primarily for notification, and cannot affect the outcome of git receive-pack.

The post-update hook can tell what are the heads that were pushed, but it does not know what their original and updated values are, so it is a poor place to do log old..new. The post-receive hook does get both original and updated values of the refs. You might consider it instead if you need them.

When enabled, the default post-update hook runs git update-server-info to keep the information used by dumb transports (e.g., HTTP) up to date. If you are publishing a Git repository that is accessible via HTTP, you should probably enable this hook.

Both standard output and standard error output are forwarded to git send-pack on the other end, so you can simply echo messages for the user.


key: push-to-checkout

description:
This hook is invoked by git-receive-pack when it reacts to git push and updates reference(s) in its repository, and when the push tries to update the branch that is currently checked out and the receive.denyCurrentBranch configuration variable is set to updateInstead. Such a push by default is refused if the working tree and the index of the remote repository has any difference from the currently checked out commit; when both the working tree and the index match the current commit, they are updated to match the newly pushed tip of the branch. This hook is to be used to override the default behaviour.

The hook receives the commit with which the tip of the current branch is going to be updated. It can exit with a non-zero status to refuse the push (when it does so, it must not modify the index or the working tree). Or it can make any necessary changes to the working tree and to the index to bring them to the desired state when the tip of the current branch is updated to the new commit, and exit with a zero status.

For example, the hook can simply run git read-tree -u -m HEAD "$1" in order to emulate git fetch that is run in the reverse direction with git push, as the two-tree form of git read-tree -u -m is essentially the same as git switch or git checkout that switches branches while keeping the local changes in the working tree that do not interfere with the difference between the branches.


key: pre-auto-gc

description: This hook is invoked by git gc --auto (see git-gc). It takes no parameter, and exiting with non-zero status from this script causes the git gc --auto to abort.


key: post-rewrite

description:
This hook is invoked by commands that rewrite commits (git-commit when called with --amend and git-rebase; however, full-history (re)writing tools like git-fast-import or git-filter-repo typically do not call it!). Its first argument denotes the command it was invoked by: currently one of amend or rebase. Further command-dependent arguments may be passed in the future.

The hook receives a list of the rewritten commits on stdin, in the format

<old-sha1> SP <new-sha1> [ SP <extra-info> ] LF
The extra-info is again command-dependent. If it is empty, the preceding SP is also omitted. Currently, no commands pass any extra-info.

The hook always runs after the automatic note copying (see "notes.rewrite.<command>" in git-config) has happened, and thus has access to these notes.

The following command-specific comments apply:

rebase
For the squash and fixup operation, all commits that were squashed are listed as being rewritten to the squashed commit. This means that there will be several lines sharing the same new-sha1.

The commits are guaranteed to be listed in the order that they were processed by rebase.


key: sendemail-validate

description: This hook is invoked by git-send-email. It takes a single parameter, the name of the file that holds the e-mail to be sent. Exiting with a non-zero status causes git send-email to abort before sending any e-mails.


key: fsmonitor-watchman

description:
This hook is invoked when the configuration option core.fsmonitor is set to .git/hooks/fsmonitor-watchman. It takes two arguments, a version (currently 1) and the time in elapsed nanoseconds since midnight, January 1, 1970.

The hook should output to stdout the list of all files in the working directory that may have changed since the requested time. The logic should be inclusive so that it does not miss any potential changes. The paths should be relative to the root of the working directory and be separated by a single NUL.

It is OK to include files which have not actually changed. All changes including newly-created and deleted files should be included. When files are renamed, both the old and the new name should be included.

Git will limit what files it checks for changes as well as which directories are checked for untracked files based on the path names given.

An optimized way to tell git "all files have changed" is to return the filename /.

The exit status determines whether git will use the data from the hook to limit its search. On error, it will fall back to verifying all files and folders.


description: This hook is invoked by git-p4 submit. It takes no parameters and nothing from standard input. Exiting with non-zero status from this script prevent git-p4 submit from launching. Run git-p4 submit --help for details.


description: Confirguration for `ops`


description: JSON Schema for API Builder's api.json format from https://app.apibuilder.io/doc/apiJson

required: name type

required: name value


key: version

description: Specifies the version of the API Builder specification that this file is written for. The latest version can be found by visiting /apicollective/apibuilder-spec.


key: contact

description: Specifies contact information for this service.


key: license

description: Specifies the license under which this service is released.


description: Specifies contact information for this service


key: name

description: Identifying name of the contact person/organization


key: url

description: URL pointing to the contact information


key: email

description: Email address of the contact person/organization


description: specifies the license under which this service is released


description: Name of the license - e.g. MIT


description: URL of the license itself


key: uri

description: The complete URI to the service specification that we are importing. Within API Builder, you can find the URL to the service specification by clicking on the "service.json" link for a service.


description: The name of the header.


key: type

description: The type of this header. Acceptable values are either the name of an enum or string. To specify a collection (meaning multiple values for this header can be provided), the type name can be wrapped with "[]". For example, to specify that the type is a collection of strings, use "[string]".


key: required

description: boolean: true|false. By default, all headers are considered required. To make a parameter optional, set "required" to false.


key: default

description: The default value for this header. If specified, generated clients will automatically include this header in all requests. Default values must be specified as strings.


key: description

description: Optional description for what this header provides. Supports GFM.


key: attributes

description: JSON Array defining additional meta data about this header for use by generators.


description: An annotation is just a short key that can be used to tag any field in any model of this API.


description: Describes what the annotation is used for.


description: the name and identifier of the attribute.


key: value

description: a JSON object that is usually utilized by a downstream Generator.


key: deprecation

description: JSON Object that indicates that this object is deprecated.


description: Optional, but recommended to contain notes for what the user is supposed to do now that this property is deprecated. Supports GFM.


description: The name of the enum. Names must be alphanumeric and must start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, interfaces, models, or unions types.


key: plural

description: Specifies the optional, plural form of the name. By default, we will pluralize the name using a basic set of english heuristics. The plural is used as a default in cases where it is more natural to specify web services. For example, the default path for a resource will be the plural.


description: Optional longer description for this enum.


key: values

description: JSON Array of EnumValue objects. Each element defines a valid value and an optional description.


description: JSON Array defining additional meta data about this enum for use by generators.


description: The name of the value. Names must start with a letter.


description: The actual string representation of this value when serializing. If not specified, defaults to 'name'.


description: Optional description for what this enum value provides. Supports GFM.


description: JSON Array defining additional meta data about this enum value for use by generators.


description: Name specifies the name of the interface. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, interfaces, or models. Note you may define an interface and a union of the same name.


description: Optional description for what this model provides. Supports GFM.


key: fields

description: JSON Array of 0 or more Fields.


description: JSON Array defining additional meta data about this model for use by generators.


description: Specifies the name of the field. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters.


description: Specifies the type of this field. Acceptable values include the name of either an enum, a model, or a (primitive type). To specify a List, the type name can be wrapped with "[]". For example, to specify that the type is a collection of strings, use "[string]". To specify a Map, the type name can be prefixed with "map[type]". For example, to specify that the type is a Map of string to long, use "map[long]". Note that for map, the keys must be strings (per the JSON specification).


description: Optional description for what this field provides. Supports GFM.


description: By default, all fields are considered required. To make a field optional, set "required" to false. When a field is marked as required, it must be present in any form of a model for that form to be valid. In client-server scenario, this means that any defaults that are present in the model must be applied by the client. If you want a default to be applied by the receiver, you should mark the field as "required": false


description: Optional default value. The value must be valid for the type specified for this field. For example, if you specify a field named 'limit' with type 'integer', an acceptable default would be 10.


key: example

description: Optional - an example value for this field used only in the produced documentation


key: minimum

description: Optional - For a string, refers to the minimum length. For an array, the minimum number of elements in the array. For example, a value of 1 for an array would indicate the array must have at least 1 element.


key: maximum

description: Optional - For a string, refers to the maximum length. For an array, the maximum number of elements in the array. For example, a value of 1 for an array would indicate the array must have at most 1 element.


description: JSON Array defining additional meta data about this field for use by generators.


key: annotations

description: JSON Array of type string where each value indicates the name of a declared annotation (optional),


key: model

description: specifies the name of the model. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, interfaces, models, or unions types.


description: Description for what this model provides.


description: Specifies the optional, plural form of the name. By default, we will pluralize the name using a basic set of english heuristics. The plural is used as a default in cases where it is more natural to specify web services. For example, the default path for a resource will be the plural.


key: interfaces

description: JSON Array of type string where each value indicates the name of a declared interface


description: Name specifies the name of the interface. Names must be alphanumeric and start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters. The name must be unique in the set of names assigned to enums, unions, or models. Note you may define an interface and a union of the same name, but in this case it is required to list that interface in the interfaces field.


key: discriminator

description: Specifies an optional, but recommended, name for a type discriminator field which can then be used in serialization / deserialization to identify the type of object. For example, if not specified, a code generator may serialize the union type into a JSON structure of { "type" => object }. If a discriminator is provided, the same code generator can flatten the JSON representation to, for example: { "discriminator" => "xxx", "field1" => "yyy" }. If provided, the name of the discriminator field must be unique across all of the fields across all of the types of this union.


description: Optional description for what this union provides. Supports GFM.


key: types

description: Specifies the individual types that are part of this union type.


description: JSON Array defining additional meta data about this union for use by generators.


key: type

description:
Specifies the type to include in this union type. Acceptable values include the name of either an enum, a model, or a (primitive type).
description optional description for what this type provides. Supports GFM.


key: default

description: If true, indicates that this type should be used as the default when deserializing union types. This field is only used by union types that require a discriminator and sets the default value for that discriminator during deserialization.


description: The discriminator value defines the string to use in the discriminator field to identify this type. If not specified, the discriminator value will default to the name of the type itself.


description: JSON Array defining additional meta data about this union type for use by generators.


description: The name of the model or enum that this resource represents


key: path

description: Optional path where this resource is located. If not provided, defaults to the plural of the typeName, with some assumptions of formatting for web (e.g. lower case, dash separated). Path parameters can be specified by prefixing a path element with ':'. For example, a path of '/:guid' would imply that all operations for this path will require a parameter named 'guid' of type 'string'


key: description

description: Optional description for what this resource provides. Supports GFM.


key: operations

description: One or more operations is required.


key: attributes

description: JSON Array defining additional meta data about this resource for use by generators.


key: method

description: The HTTP method for this operation


description: Optional path for this particular operation. If not provided, defaults to no additional path. Path parameters can be specified by prefixing a path element with ':'. For example, a path of '/:guid' would imply that this operation is available at /resource_path/:guid. Path parameter types are inferred by looking for a field with that name on the model associated with this resource. If not found, the datatype of any path parameter will be string.


description: Optional description for what this operation provides. Supports GFM.


key: body

description: Optional specification for the type of the body of this request. For all operations that support bodies (e.g. POST, PUT, PATCH), allows you to specify the type of the body.


key: parameters

description: Optional JSON Array of the parameters to this method. By default, for GET methods, parameters are assumed to be in the path or in the query. For other methods, parameters are assumed to be in the path or form body, unless you have explicitly specified a body in which case parameters can be provided in the path or the query.


key: responses

description: Optional JSON Object of HTTP Response Code to Response. If not provided, an HTTP NoContent response is assumed. Only responses for HTTP status codes that are interesting should be documented.


description: JSON array defining additional meta data about this operation for use by generators.


key: name

description: The name of the parameter. Names must be alphanumeric and must start with a letter. Valid characters are a-z, A-Z, 0-9 and _ characters.


description: Specifies the type of this parameter. Acceptable values include the name of either an enum, a model, or a (primitive type). To specify a List, the type name can be wrapped with "[]". For example, to specify that the type is a collection of strings, use "[string]". To specify a Map, the type name can be prefixed with "map[type]". For example, to specify that the type is a Map of string to long, use "map[long]". Note that for map, the keys must be strings (per the JSON specification).


key: location

description: One of: path, query, form, header. Defines the location of this parameter. Default location varies based on the context of the parameter (e.g. if the operation method is a POST, the default will be Form; if a GET, the default will be Query)


description: Optional description for what this parameter provides. Supports GFM.


key: required

description: By default all parameters are considered required. To make a parameter optional, set "required" to false.


description: Optional default value. The value must be valid for the type specified for this parameter. For example, if you specify a parameter named 'limit' with type 'integer', an acceptable default would be 10


key: example

description: Optional - an example value for this parameter used only in the produced documentation


key: minimum

description: Optional - For a string, refers to the minimum length. For an array, the minimum number of elements in the array. For example, a value of 1 for an array would indicate the array must have at least 1 element.


key: maximum

description: Optional - For a string, refers to the maximum length. For an array, the maximum number of elements in the array. For example, a value of 1 for an array would indicate the array must have at most 1 element.


description: JSON array defining additional meta data about this parameter for use by generators.


description:
A valid HTTP status code for this response (e.g. 200). Only status codes that have interesting return types should be documented. You can also specify an HTTP status code of 'default' to map to all other non documented types. This is useful to capture a generic error type that would be returned for non documented response codes.

There are a few conventions enforced:
- HTTP Response codes of 5xx cannot be explicitly specified and are handled automatically to ensure consistent behavior in generated client libraries.
- HTTP Response codes of 204 and 304 indicate that no content is returned, so they must use a type of unit.


description: Specifies the type of this response. Acceptable values include the name of either an enum, a model, or a (primitive type). To specify a List, the type name can be wrapped with "[]". For example, to specify that the type is a collection of strings, use "[string]". To specify a Map, the type name can be prefixed with "map[type]". For example, to specify that the type is a Map of string to long, use "map[long]". Note that for map, the keys must be strings (per the JSON specification).


description: Optional description for what this response provides. Supports GFM.


description: JSON Array defining additional meta data about this service. Attributes are used to add custom extensions to API Builder and are typically used by generators to enable advanced code generation.


description: Specifies the type of this body. Acceptable values include the name of either an enum, a model, or a (primitive type). To specify a List, the type name can be wrapped with "[]". For example, to specify that the type is a collection of strings, use "[string]". To specify a Map, the type name can be prefixed with "map[type]". For example, to specify that the type is a Map of string to long, use "map[long]". Note that for map, the keys must be strings (per the JSON specification).


description: Optional description for what this body provides. Supports GFM.


description: JSON Array defining additional meta data about this body for use by generators.


key: $schema

description: A JSON schema URL


description: The human readable name of this service. Used for display, and as the basis for generating a unique key for URL.


key: apidoc

description: Optionally specify the specific version of API Builder for which your service is written. If not provided, we automatically default to the current production version.


key: info

description: Optionally specify additional metadata about this service (e.g. contact info, license).


key: namespace

description: Specifies the namespace for this service. Namespace is primarily used when other services import definitions from your service and in the code generators when defining things like package names. If not specified, we will automatically generate a namespace based on [organization namespace].[formatted service name].[major version number]. Note that by default API Builder includes the major version number in the package name which allows service authors and clients to interact with multiple versions of the service where changes have been made in a non backwards compatible way.


description: The base URL where this service is hosted. Must start with http.


key: description

description: optional description for what this service provides. Supports GFM.


key: imports

description: JSON Array defining any other services whose schema definitions we would like to import into our service.


key: headers

description: JSON Array defining any HTTP Headers that the service understands or expects.


key: enums

description: JSON object defining all of the enums in this API. The key of each object is the enum name.


key: models

description: JSON object defining all of the models in this API. The key of each object is the model name.


key: resources

description: JSON object defining all of the resources in this API. The key of each object is the name of a type that this resource represents. The type must be the name of a model or an enum.


key: annotations

description: JSON object defining all of the annotations in this API. The key of each object is the annotation name.


description: LOOBin base class

enum:
Reconnaissance
Resource Development
Initial Access
Execution
Persistence
Privilege Escalation
Defense Evasion
Credential Access
Discovery
Lateral Movement
Collection
Exfiltration
Command and Control
Impact

required: name description

required: name url

format: date


key: ExampleUseCase

description: Use case base class


key: Detection

description: Detection base class


key: Resource

description: External reference base class


key: name

description: Name of the LOOBin


key: author

description: Author of the LOOBin


description: A short description of the LOOBin.This will display in the LOOBin card list and the LOOBins website search results.


description: A full description of the LOOBin.This will display on the LOOBin's single page.


key: created

description: Date the LOOBin was created


description: A list of example use cases for the LOOBin


key: paths

description: A list of paths to the LOOBin


key: detections

description: A list of detections for the LOOBin


description: A list of useful resources for the LOOBin


key: acknowledgements

description: Acknowledgements for the LOOBin


description: Schema for bundleconfig.json files


key: commands

description: The friendly name of the command.


key: fileName

description: The name of the executable file name. Example: "cmd.exe".


key: workingDirectory

description: Specify a relative or absolute directory path.


key: arguments

description: The arguments to pass to the executable file.


key: vsbindings

description: A Visual Studio event that a command can be bound to.


description: A list of commands.


key: -vs-binding

description: Specify any Visual Studio event bindings.


key: env

description: This is an object of keys that represent different environments. For example, you may have: `{ env: { production: { /* specific options */ } } }` which will use those options when the environment variable BABEL_ENV is set to "production". If BABEL_ENV isn't set then NODE_ENV will be used, if it's not set then it defaults to "development"


key: ast

description: Include the AST in the returned object


key: auxiliaryCommentAfter

description: Attach a comment after all non-user injected code.


key: auxiliaryCommentBefore

description: Attach a comment before all non-user injected code.


key: code

description: Enable code generation


key: comments

description: Output comments in generated output.


key: compact

description: Do not include superfluous whitespace characters and line terminators. When set to "auto" compact is set to true on input sizes of >500KB.

type: string boolean

default: auto


key: extends

description: A path to a .babelrc file to extend


key: filename

description: Filename for use in errors etc.

default: unknown


key: filenameRelative

description: Filename relative to sourceRoot (defaults to "filename")


key: highlightCode

description: ANSI highlight syntax error code frames


key: ignore

description: Opposite of the "only" option


key: inputSourceMap

description: If true, attempt to load an input sourcemap from the file itself. If an object is provided, it will be treated as the source map object itself.

type: boolean object


key: keepModuleIdExtensions

description: Keep extensions in module ids


key: moduleId

description: Specify a custom name for module ids.


key: moduleIds

description: If truthy, insert an explicit id for modules. By default, all modules are anonymous. (Not available for common modules)


key: moduleRoot

description: Optional prefix for the AMD module formatter that will be prepend to the filename on module definitions. (defaults to "sourceRoot")


key: only

description: A glob, regex, or mixed array of both, matching paths to only compile. Can also be an array of arrays containing paths to explicitly match. When attempting to compile a non-matching file it's returned verbatim.


key: plugins

description: List of plugins to load and use


key: items

description: The name of the plugin.


description: The options of the plugin.


key: presets

description: List of presets (a set of plugins) to load and use


description: The name of the preset.


description: The options of the preset.


key: retainLines

description: Retain line numbers. This will lead to wacky code but is handy for scenarios where you can't use source maps. NOTE: This will obviously not retain the columns.


key: sourceFileName

description: Set sources[0] on returned source map. (defaults to "filenameRelative")


key: sourceMaps

description: If truthy, adds a map property to returned output. If set to "inline", a comment with a sourceMappingURL directive is added to the bottom of the returned code. If set to "both" then a map property is returned as well as a source map comment appended.


key: sourceMapTarget

description: Set file on returned source map. (defaults to "filenameRelative")


key: sourceRoot

description: The root from which all sources are relative. (defaults to "moduleRoot")


description: Base class for extension properties which are shared by the extension manifest and the extension model

required: id targets type

enum: dark light

enum:
Azure Repos
Azure Boards
Azure Pipelines
Azure Test Plans
Azure Artifacts


key: Badge

description: A link to external metadata badge.


key: href

description: Link the user navigates to when selecting the badge.


key: uri

description: The absolute URL of the badge image to be displayed.


key: description

description: Description of the badge, to be displayed on hover.


key: Content

description: A content file that describes the extension to users.


key: path

description: The path to the file in the extension.


key: Contribution

description: An individual contribution made by an extension


key: constraints

description: List of constraints (filters) that should be applied to the availability of this contribution


description: Description of the contribution/type


key: id

description: Fully qualified identifier of the contribution/type


key: includes

description: Includes is a set of contributions that should have this contribution included in their targets list.


key: properties

description: Properties/attributes of this contribution


key: restrictedTo

description: List of demanded claims in order for the user to see this contribution (like anonymous, public, member...).


key: targets

description: The ids of the contribution(s) that this contribution targets. (parent contributions)


key: type

description: Id of the Contribution Type


key: visibleTo

description: VisibleTo can be used to restrict whom can reference a given contribution/type. This value should be a list of publishers or extensions access is restricted too.  Examples: "ms" - Means only the "ms" publisher can reference this. "ms.vss-web" - Means only the "vss-web" extension from the "ms" publisher can reference this.


key: ContributionConstraint

description: Specifies a constraint that can be used to dynamically include/exclude a given contribution


key: group

description: An optional property that can be specified to group constraints together. All constraints within a group are AND'd together (all must be evaluate to True in order for the contribution to be included). Different groups of constraints are OR'd (only one group needs to evaluate to True for the contribution to be included).


description: Fully qualified identifier of a shared constraint


key: inverse

description: If true, negate the result of the filter (include the contribution if the applied filter returns false instead of true)


key: name

description: Name of the IContributionFilter plugin


description: Properties that are fed to the contribution filter class


key: relationships

description: Constraints can be optionally be applied to one or more of the relationships defined in the contribution. If no relationships are defined then all relationships are associated with the constraint. This means the default behaviour will eliminate the contribution from the tree completely if the constraint is applied.


key: ContributionLicensingBehaviorType

description: Represents different ways of including contributions based on licensing


key: ContributionPropertyDescription

description: Description about a property of a contribution type


key: description

description: Description of the property


description: Name of the property


key: required

description: True if this property is required


description: The type of value used for this property


key: ContributionPropertyType

description: The type of value used for a property


key: ContributionType

description: A contribution type, given by a json schema


description: Description of the contribution/type


key: id


key: indexed

description: Controls whether or not contributions of this type have the type indexed for queries. This allows clients to find all extensions that have a contribution of this type.  NOTE: Only TrustedPartners are allowed to specify indexed contribution types.


description: Friendly name of the contribution/type


key: properties

description: Describes the allowed properties for this contribution type


key: ExtensionEventCallback

description: Base class for an event callback for an extension


key: uri

description: The uri of the endpoint that is hit when an event occurs


key: ExtensionEventCallbackCollection

description: Collection of event callbacks - endpoints called when particular extension events occur.


key: postDisable

description: Optional.  Defines an endpoint that gets called via a POST request to notify that an extension disable has occurred.


key: postEnable

description: Optional.  Defines an endpoint that gets called via a POST request to notify that an extension enable has occurred.


key: postInstall

description: Optional.  Defines an endpoint that gets called via a POST request to notify that an extension install has completed.


key: postUninstall

description: Optional.  Defines an endpoint that gets called via a POST request to notify that an extension uninstall has occurred.


key: postUpdate

description: Optional.  Defines an endpoint that gets called via a POST request to notify that an extension update has occurred.


key: preInstall

description: Optional.  Defines an endpoint that gets called via a POST request to notify that an extension install is about to occur.  Response indicates whether to proceed or abort.


key: versionCheck

description: For multi-version extensions, defines an endpoint that gets called via an OPTIONS request to determine the particular version of the extension to be used


key: ExtensionLicensing

description: How an extension should handle including contributions based on licensing


key: overrides

description: A list of contributions which deviate from the default licensing behavior


key: path

description: Path to resource on disk, which can be relative to your root directory.


key: addressable

description: (optional) Set to true if you want your file to be URL-addressable. Defaults to false.


key: packagePath

description: (optional) Path to the resource within the package. Defaults to the relative path on disk from your root directory.


key: contentType

description: (optional) MIME type of the file. Defaults to a best guess based on the file extension and OS settings.


key: assetType

description: (optional) Specify the value of the Type attribute of the asset entry in the VSIX manifest. Can also be an array of strings, in which case multiple asset entries get added for this file. Defaults to the packagePath.


key: lang

description: (optional) Language of this asset. Localized files are served based on the Accept-Language header. Leave blank to signify this file is in the default (or fallback) language. Localized versions of the same file should have the same assetType.


key: LicensingOverride

description: Maps a contribution to a licensing behavior


key: behavior

description: How the inclusion of this contribution should change based on licensing


key: id

description: Fully qualified contribution id which we want to define licensing behavior for


key: uri

description: The absolute URL of the link.


key: badges

description: Array of links to external metadata badges like TravisCI, Appveyor, and so on, from the approved badges sites.


key: baseUri

description: Uri used as base for other relative uri's defined in extension


key: branding

description: Dictionary of brand-related properties.


key: color

description: Primary color of the extension or publisher; can be a hex (#ff00ff), RGB (rgb(100,200,50)), or supported HTML color names (blue).


key: theme

description: Complements the color; use dark for dark branding colors, or light for lighter branding colors.


key: categories

description: Array of strings representing the categories your extension belongs to. At least one category must be provided and there's no limit to how many categories you may include. Valid values: Azure Repos, Azure Boards, Azure Pipelines, Azure Test Plans, and Azure Artifacts.


key: constraints

description: List of shared constraints defined by this extension


key: content

description: Dictionary of content files that describe your extension to users.


key: contributionTypes

description: List of contribution types defined by this extension


key: contributions

description: List of contributions made by this extension


key: demands

description: List of explicit demands required by this extension


key: description

description: A few sentences describing the extensions. Limited to 200 characters.


key: eventCallbacks

description: Collection of endpoints that get called when particular extension events occur


key: fallbackBaseUri

description: Secondary location that can be used as base for other relative uri's defined in extension


key: files

description: The files section is where you reference any files you wish to include in your extension.


key: icons

description: Dictionary of icons representing the extension.


key: default

description: 128x128 pixels


key: id

description: The extension's identifier.


key: language

description: Language Culture Name set by the Gallery


key: licensing

description: How this extension behaves with respect to licensing


key: manifestVersion

description: Version of the extension manifest format/content. Should be 1.


key: name

description: A short, human-readable name of the extension. Limited to 200 characters.


key: links

description: Dictionary of links that help users learn more about your extension, get support, and move.


key: publisher

description: The identifier of the publisher. This identifier must match the identifier the extension is published under.


key: repository

description: Dictionary of properties describing the source code repository for the extension.


key: type

description: Type of repository. Example: git.


key: uri

description: Absolute URL of the repository.


key: restrictedTo

description: Default user claims applied to all contributions (except the ones which have been specified restrictedTo explicitly) to control the visibility of a contribution.


key: scopes

description: List of all oauth scopes required by this extension


key: screenshots

description: Array of images that couldn't be included in your content.


key: serviceInstanceType

description: The ServiceInstanceType(Guid) of the VSTS service that must be available to an account in order for the extension to be installed


key: tags

description: Array of string tags to help users find your extension.


key: targets

description: The products and services supported by your integration or extension.


key: version

description: A string specifying the version of an extension. Should be in the format major.minor.patch.


Any property starting with _ is valid.


description: The name of your package.


key: description

description: Help users identify and search for your package with a brief description.


description: A semantic version number.


key: main

description: The primary acting files necessary to use your package.


key: license

description: SPDX license identifier or path/url to a license.


key: ignore

description: A list of files for Bower to ignore when installing your package.


key: keywords

description: Used for search by keyword. Helps make your package easier to discover without people needing to know its name.


key: authors

description: A list of people that authored the contents of the package.


key: homepage

description: URL to learn more about the package. Falls back to GitHub project if not specified and it's a GitHub endpoint.


key: repository

description: The repository in which the source code can be found.


key: dependencies

description: Dependencies are specified with a simple hash of package name to a semver compatible identifier or URL.


key: devDependencies

description: Dependencies that are only needed for development of the package, e.g., test framework or building documentation.


key: resolutions

description: Dependency versions to automatically resolve with if conflicts occur between packages.


key: private

description: If you set it to  true  it will refuse to publish it. This is a way to prevent accidental publication of private repositories.


key: exportsOverride

description: Used by grunt-bower-task to specify custom install locations.


key: moduleType

description: The types of modules this package exposes

type: array string

enum: amd es6 globals node yui


key: imports

description: The Imports field


key: scopes

description: The Scopes field


key: dataType

description: The data type hint for the binding parameter (string, binary, or stream).

enum: string binary stream


key: queueName

description: The service bus queue to monitor (if using a queue)


key: topicName

description: The service bus topic to monitor (if using a queue)


key: subscriptionName

description: The topic subscription name


key: connection

description: An app setting (or environment variable) with the service bus connection string to be used by this binding.


key: accessRights

description: The permission level of the service bus connection string used by this binding.

enum: manage listen send


key: path

description: The path to the blob container


description: An app setting (or environment variable) with the storage connection string to be used by this binding.


description: The event hub path.


description: The event hub connection string setting.


key: consumerGroup

description: The event hub consumer group.


key: cardinality

description: The cardinality hint for the input binding parameter (single message or array of messages).

enum: one many


key: schedule

description: A cron expression of the format '{second} {minute} {hour} {day} {month} {day of week}' to specify the schedule.


key: runOnStartup

description: When true, your timer function will be invoked immediately after a runtime restart and on-schedule thereafter.


key: useMonitor

description: When true, schedule will be persisted to aid in maintaining the correct schedule even through restarts. Defaults to true for schedules with interval >= 1 minute.


description: The queue name.


key: route

description: The function HTTP route template.


key: webHookType

description: The type of WebHook handled by the trigger (if handling a pre-defined WebHook).


key: authLevel

description: The function HTTP authorization level.

default: function

enum: anonymous function admin


key: tableName

description: This is the name of the table within your Mobile App to which data will be written.


description: This is the app setting name that specifies the URL of your Mobile App.


key: apiKey

description: This is app setting name that specifies the API Key for your Mobile App.


key: id

description: This is the id for the record to retrieve.


description: This is the connection string for your DocumentDB account.


key: databaseName

description: This is the name of the database within your DocumentDB account to which data will be written.


key: collectionName

description: This is the name of the collection within your database to which data will be written.


key: sqlQuery

description: This is the query to run against the collection.


key: createIfNotExists

description: When true, your database and collection will be created automatically.


description: The name of the storage table.


key: partitionKey

description: The partition key.


key: rowKey

description: The table row key.


key: connection


key: take

description: The number or records to retrieve.


key: filter

description: A filter expression to be applied when retrieving rows.


key: tagExpression

description: The tag to send the notification to.


key: hubName

description: The name of the notification hub.


description: The name of the app setting which contains the notification hub connection string.


key: platform

description: The notification platform to target. Sends template notification if platform is omitted.

enum: apns adm gcm wns mpns


key: accountSid

description: The name of the app setting which contains your Twilio Account Sid.


key: authToken

description: The name of the app setting which contains your Twilio authentication token.


key: to

description: The phone number the SMS text is sent to.


key: from

description: The phone number the SMS text is sent from.


key: body

description: Optional body of SMS text message.


key: apiKey

description: The name of the app setting which contains your SendGrid api key.


description: The email address to send to.


description: The email address to send from.


key: subject

description: The subject of the email.


key: text

description: The text of the email.


key: connectionStringSetting

description: The name of the app setting that contains the SQL connection string used to connect to the database.


key: tableName

description: The name of the table to be monitored for changes.


key: commandText

description: Either a query string or the name of a stored procedure to execute.


key: commandType

description: Whether the commandText is a query (text) or a stored procedure (storedProcedure).

enum: text storedProcedure


key: parameters

description: The parameters to the query or stored procedure.


description: The name of the table into which rows will be upserted.


key: connection

description: Name of the app setting that contains the kusto connection string used to connect to kusto.


key: database

description: Name of the database within your kusto account to which data will be read/written.


key: managedServiceIdentity

description: A managed service identity that has to be attached to use the bindings.


key: kqlCommand

description: The Kusto command to execute.Can be a KQL query or a KQL function with optional parameters.


key: kqlParameters

description: The parameters to the query or function. Named parameters are of the form @paramName=paramValue.


description: The table to ingest the data into.


key: mappingRef

description: An ingestion mapping ref that points to the mapping created in kusto and referenced in ingestion (optional).


key: dataFormat

description: Dataformat to use in ingestion.The default dataformat is `multijson/json`. This has been tested for text formats


key: disabled

description: If set to true, marks the function as disabled (it cannot be triggered).


key: excluded

description: If set to true, the function will not be loaded, compiled, or triggered.


key: scriptFile

description: Optional path to function script file.


key: entryPoint

description: Optional named entry point.


key: configurationSource

description: For C# precompiled functions only. If set to 'attributes', use WebJobs attributes to specify bindings. Otherwise, use the 'bindings' property of this function.json.

enum: attributes config


key: retry

description: Retry policy of function execution failures.

enum: exponentialBackoff fixedDelay

default: exponentialBackoff


key: strategy

description: Retry strategy to use for retrying function executions


key: maxRetryCount

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


key: delayInterval

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


key: minimumInterval

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


key: maximumInterval

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


key: bindings

description: A list of function bindings.


key: configFile

description: ConfigFile is a multiline string that represent a custom webhook config file


key: cacheTimeout

description: CacheTimeout controls how long to cache authentication decisions


description: Authentication strategy that will be used in kubernetes cluster


key: sans

description: List of additional hostnames and IPs to include in the api server PKI cert


key: webhook

description: Webhook configuration options


key: mode

description: Authorization mode used by kubernetes


key: options

description: Authorization mode options


key: cloud

description: The cloud environment identifier. Takes values from https://github.com/Azure/go-autorest/blob/ec5f4903f77ed9927ac95b19ab8e44ada64c1356/autorest/azure/environments.go#L13


key: tenantId

description: The AAD Tenant ID for the Subscription that the cluster is deployed in


key: subscriptionId

description: The ID of the Azure Subscription that the cluster is deployed in


key: resourceGroup

description: The name of the resource group that the cluster is deployed in


key: location

description: The location of the resource group that the cluster is deployed in


key: vnetName

description: The name of the VNet that the cluster is deployed in


key: vnetResourceGroup

description: The name of the resource group that the Vnet is deployed in


key: subnetName

description: The name of the subnet that the cluster is deployed in


key: securityGroupName

description: The name of the security group attached to the cluster's subnet


key: routeTableName

description: (Optional in 1.6) The name of the route table attached to the subnet that the cluster is deployed in


key: primaryAvailabilitySetName

description:
(Optional) The name of the availability set that should be used as the load balancer backend
If this is set, the Azure cloudprovider will only add nodes from that availability set to the load
balancer backend pool. If this is not set, and multiple agent pools (availability sets) are used, then
the cloudprovider will try to add all nodes to a single backend pool which is forbidden.
In other words, if you use multiple agent pools (availability sets), you MUST set this field.


key: vmType

description:
The type of azure nodes. Candidate valudes are: vmss and standard.
If not set, it will be default to standard.


key: primaryScaleSetName

description:
The name of the scale set that should be used as the load balancer backend.
If this is set, the Azure cloudprovider will only add nodes from that scale set to the load
balancer backend pool. If this is not set, and multiple agent pools (scale sets) are used, then
the cloudprovider will try to add all nodes to a single backend pool which is forbidden.
In other words, if you use multiple agent pools (scale sets), you MUST set this field.


key: aadClientId

description:
The ClientID for an AAD application with RBAC access to talk to Azure RM APIs
This's used for service principal authentication: https://github.com/Azure/aks-engine/blob/master/docs/topics/service-principals.md


key: aadClientSecret

description:
The ClientSecret for an AAD application with RBAC access to talk to Azure RM APIs
This's used for service principal authentication: https://github.com/Azure/aks-engine/blob/master/docs/topics/service-principals.md


key: aadClientCertPath

description:
The path of a client certificate for an AAD application with RBAC access to talk to Azure RM APIs
This's used for client certificate authentication: https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-protocols-oauth-service-to-service


key: aadClientCertPassword

description:
The password of the client certificate for an AAD application with RBAC access to talk to Azure RM APIs
This's used for client certificate authentication: https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-protocols-oauth-service-to-service


key: cloudProviderBackoff

description: Enable exponential backoff to manage resource request retries


key: cloudProviderBackoffRetries

description: Backoff retry limit


key: cloudProviderBackoffExponent

description: Backoff exponent


key: cloudProviderBackoffDuration

description: Backoff duration


key: cloudProviderBackoffJitter

description: Backoff jitter


key: cloudProviderRateLimit

description: Enable rate limiting


key: cloudProviderRateLimitQPS

description: Rate limit QPS


key: cloudProviderRateLimitBucket

description: Rate limit Bucket Size


key: useInstanceMetadata

description: Use instance metadata service where possible


key: useManagedIdentityExtension

description:
Use managed service identity for the virtual machine to access Azure ARM APIs
This's used for managed identity authentication: https://docs.microsoft.com/en-us/azure/active-directory/managed-service-identity/overview
For user-assigned managed identity, need to set the below UserAssignedIdentityID


key: userAssignedIdentityID

description:
The Client ID of the user assigned MSI which is assigned to the underlying VMs
This's used for managed identity authentication: https://docs.microsoft.com/en-us/azure/active-directory/managed-service-identity/overview


key: maximumLoadBalancerRuleCount

description: Maximum allowed LoadBalancer Rule Count is the limit enforced by Azure Load balancer, default(0) to 148


key: loadBalancerSku

description: Sku of Load Balancer and Public IP: `basic` or `standard`, default(blank) to `basic`


key: excludeMasterFromStandardLB

description:
Excludes master nodes (labeled with `node-role.kubernetes.io/master`) from the backend pool of Azure standard loadbalancer, default(nil) to `true`
If want adding the master nodes to ALB, this should be set to `false` and remove the `node-role.kubernetes.io/master` label from master nodes


key: address

description: Address of Bastion Host


key: port

description: SSH Port of Bastion Host


key: user

description: ssh User to Bastion Host


key: sshAgentAuth

description: SSH Agent Auth enable


key: sshKey

description: SSH Private Key


key: sshKeyPath

description: SSH Private Key Path


key: sshCert

description: SSH Certificate


key: sshCertPath

description: SSH Certificate Path


key: ignoreProxyEnvVars

description: Ignore proxy environment variables


key: bs-version

description: overrides autodetection. v1 or v2. Defaults to auto


key: trust-device-path

description: See Issue #33128


key: cloudProvider

description: Cloud provider type used with calico


key: name

description: Name of the Cloud Provider


key: awsCloudProvider

description: AWSCloudProvider


key: azureCloudProvider

description: AzureCloudProvider


key: openstackCloudProvider

description: OpenstackCloudProvider


key: vsphereCloudProvider

description: VsphereCloudProvider


key: customCloudProvider

description: CustomCloudProvider is a multiline string that represent a custom cloud config file


key: provider

description: DNS provider


key: options

description: DNS config options


key: upstreamnameservers

description: Upstream nameservers


key: reversecidrs

description: ReverseCIDRs


key: stubdomains

description: Stubdomains


key: nodeSelector

description: NodeSelector key pair


key: nodelocal

description: Nodelocal DNS


key: updateStrategy

description: Update strategy


key: linearAutoscalerParams

description: Autoscaler fields to determine number of dns replicas


key: tolerations

description: Tolerations for Deployments


key: externalUrls

description: List of etcd urls


key: caCert

description: External CA certificate


key: cert

description: External Client certificate


key: key

description: External Client key


key: path

description: External etcd prefix


key: uid

description: UID to run etcd container as


key: gid

description: GID to run etcd container as


key: snapshot

description: Etcd Recurring snapshot Service, used by rke only


key: retention

description: Etcd snapshot Retention period


key: creation

description: Etcd snapshot Creation period


key: backupConfig

description: Backup backend for etcd snapshots


key: iface

description: Alternate cloud interface for flannel


key: zone

description:
TODO: Is there any use for this?  We can get it from the instance metadata service
Maybe if we're not running on AWS, e.g. bootstrap; for now it is not very useful


key: vpc

description:
The AWS VPC flag enables the possibility to run the master components
on a different aws account, on a different cloud provider or on-premises.
If the flag is set also the KubernetesClusterTag must be provided


key: subnet-id

description: SubnetID enables using a specific subnet to use for ELB's


key: routetable-id

description: RouteTableID enables using a specific RouteTable


key: role-arn

description: RoleARN is the IAM role to assume when interaction with AWS APIs.


key: kubernetes-cluster-tag

description: KubernetesClusterTag is the legacy cluster id we'll use to identify our cluster resources


key: kubernetes-cluster-id

description: KubernetesClusterID is the cluster id we'll use to identify our cluster resources


key: disable-security-group-ingress

description:
The aws provider creates an inbound rule per load balancer on the node security
group. However, this can run into the AWS security group rule limit of 50 if
many LoadBalancers are created.

This flag disables the automatic ingress creation. It requires that the user
has setup a rule that allows inbound traffic on kubelet ports from the
local VPC subnet (so load balancers can access it). E.g. 10.82.0.0/16 30000-32000.


key: elb-security-group

description:
AWS has a hard limit of 500 security groups. For large clusters creating a security group for each ELB
can cause the max number of security groups to be reached. If this is set instead of creating a new
Security group for each ELB this security group will be used instead.


key: disable-strict-zone-check

description:
During the instantiation of an new AWS cloud provider, the detected region
is validated against a known set of regions.

In a non-standard, AWS like environment (e.g. Eucalyptus), this check may
be undesirable.  Setting this to true will disable the check and provide
a warning that the check was skipped.  Please note that this is an
experimental feature and work-in-progress for the moment.  If you find
yourself in an non-AWS cloud and open an issue, please indicate that in the
issue body.