key: secretkey

description: secretkey specifies the aws secret key which combined with `accesskey`, is one of the way to authenticate


key: filters

description: Filters specifies a list of AMI filters

type: string

type: object

type: array


key: items

description: Filter represents the updatecli configuration describing AMI filters.


key: name

description: Name specifies a filter name.


key: values

description: Values specifies a filter value for a specific filter name.


key: region

description: Region specifies the AWS region to use when looking for AMI


key: endpoint

description: Endpoint specifies the AWS endpoint to use when looking for AMI


key: dryrun

description: Dryrun allows to Check whether you have the required permissions for the action.

type: boolean


key: sortby

description: Sortby specifies the order of AMI-ID that will be used to retrieve the last element such as `creationdateasc`


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed

required: from to

type: integer


description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines settings used to interact with GitLab release

required: url owner repository


key: url

description:
"url" defines the GitLab url to interact with

		default:
			url defaults to "gitlab.com"


key: username

description: "username" defines the username used to authenticate with GitLab


key: token

description: "token" defines the credential used to authenticate with GitLab


key: owner

description: [S][C] Owner specifies repository owner


key: repository

description: [S][C] Repository specifies the name of a repository for a specific owner


key: versionfilter

description: [S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.


key: kind

description: specifies the version kind such as semver, regex, or latest


description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


key: branch

description: [C] Branch specifies the branch name


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines settings used to interact with GitLab release


key: url

description:
"url" defines the GitLab url to interact with

		default:
			url defaults to "gitlab.com"


key: username

description: "username" defines the username used to authenticate with GitLab


key: token

description: "token" defines the credential used to authenticate with GitLab


key: owner

description: [S][C][T] Owner specifies repository owner


key: repository

description: [S][C][T]Repository specifies the name of a repository for a specific owner


key: versionfilter

description: [S] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.


key: kind

description: specifies the version kind such as semver, regex, or latest


description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


key: title

description: [T] Title defines the GitLab release title.


key: tag

description: [C][T] Tag defines the GitLab release tag.


key: commitish

description: [T] Commitish defines the commit-ish such as `main`


key: description

description: [T] Description defines if the new release description


key: draft

description: [T] Draft defines if the release is a draft release


key: prerelease

description: [T] Prerelease defines if the release is a pre-release release


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: Spec defines a specification for a "Golang" resource parsed from an updatecli manifest file


key: file

description: File defines the go.mod file, default to "go.mod"


key: module

description: Module defines the module path


key: indirect

description: Indirect specifies if we manipulate an indirect dependency


key: version

description: Version Defines a specific golang version


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: file

description: [s][c][t] File specifies the toml file to manipulate


key: files

description: [c][t] Files specifies a list of Json file to manipulate


key: query

description: [s][c][t] Query allows to used advanced query. Override the parameter key


key: key

description: [s][c][t] Key specifies the query to retrieve an information from a toml file


key: value

description: [s][c][t] Value specifies the value for a specific key. Default to source output


key: versionfilter

description: [s] VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.


key: kind

description: specifies the version kind such as semver, regex, or latest


description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


key: createmissingkey

description:
[t] CreateMissingKey allows non-existing keys. If the key does not exist, the key is created if AllowsMissingKey
	  is true, otherwise an error is raised (the default).
	  Only supported if Key is used


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: spec

description: "yaml" defines the specification for manipulating "yaml" files.


key: file

description:
"file" defines the yaml file path to interact with.

		compatible:
			* source
			* condition
			* target

		remark:
			* "file" and "files" are mutually exclusive
			* scheme "https://", "http://", and "file://" are supported in path for source and condition


key: files

description:
"files" defines the list of yaml files path to interact with.

		compatible:
			* condition
			* target

		remark:
			* file and files are mutually exclusive
			* protocols "https://", "http://", and "file://" are supported in file path for source and condition


key: key

description:
"key" defines the yaml keypath.

		compatible:
			* source
			* condition
			* target

		remark:
			* key is a simpler version of yamlpath accepts keys.

		example:
			* key: $.name
			* key: $.agent.name
			* key: $.agents[0].name
			* key: $.agents[*].name
			* key: $.'agents.name'

		remark:
			field path with key/value is not supported at the moment.
			some help would be useful on https://github.com/goccy/go-yaml/issues/290


key: value

description:
"value" is the value associated with a yaml key.

		compatible:
			* source
			* condition
			* target

		default:
			When used from a condition or a target, the default value is set to linked source output.


key: keyonly

description:
"keyonly" allows to only check if a key exist and do not return an error otherwise

		compatible:
			* condition

		default:
			false


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: dependson

description: dependson specifies which resources must be executed before the current one


key: name

description: name specifies the resource name


key: transformers

description: transformers defines how the default input value need to be transformed


key: items

description: Transformer holds a transformer rule


key: addprefix

description: AddPrefix adds a prefix to the transformer input value


key: addsuffix

description: AddSuffix adds a suffix to the transformer input value


key: trimprefix

description: TrimPrefix removes a prefix to the transformer input value


key: trimsuffix

description: TrimSuffix removes the suffix from the transformer input value


key: replacers

description: Replacers specifies a list of replacer instruction


description: Replacer is struct used to feed strings.Replacer


key: from

description: From defines the source value which need to be replaced


key: to

description: To defines the "to what" a "from" value needs to be replaced


key: replacer

description: Replacer specifies what value needs to be changed and how


key: find

description: Find searches for a specific value if it exists and return false if it doesn't


key: findsubmatch

description: Find searches for a specific value if it exists then return the value using regular expression


key: pattern

description: Pattern defines regular expression to use for retrieving a submatch


key: captureindex

description: CaptureIndex defines which substring occurrence to retrieve. Note also that a value of `0` for `captureIndex` returns all submatches, and individual submatch indexes start at `1`.


key: semverinc

description: SemvVerInc specifies a  comma separated list semantic versioning component that needs to be upgraded.


key: file

description: [s][c][t] File specifies the csv file


key: files

description: [c][t] Files specifies a list of Json file to manipulate


key: key

description: [s][c][t] Key specifies the csv query


key: query

description: [s][c][t] Query allows to used advanced query. Override the parameter key


key: value

description: [s][c][t] Key specifies the csv value, default to source output


key: comma

description: [s][c][t] Comma specifies the csv separator character, default ","


key: comment

description: [s][c][t] Comma specifies the csv comment character, default "#"


key: versionfilter

description: [s]VersionFilter provides parameters to specify version pattern and its type like regex, semver, or just latest.


key: kind

description: specifies the version kind such as semver, regex, or latest


description: specifies the version pattern according the version kind


key: strict

description: strict enforce strict versioning rule. Only used for semantic versioning at this time


key: scmid

description: scmid specifies the scm configuration key associated to the current resource


key: version

description: Version specifies the minimum updatecli version compatible with the manifest


Hidden keys.


Arbitrary YAML anchor.


key: junit

description: Path for file(s) that should be parsed as JUnit XML result


description: Path to a single XML file


description: A list of paths to XML files that will automatically be concatenated into a single file


description: Path to a single file with browser performance metric report(s).


description: Used to collect coverage reports from the job.


Code coverage format used by the test framework.


key: path

description: Path to the coverage report file that should be parsed.


key: codequality

description: Path to file or list of files with code quality report(s) (such as Code Climate).


key: dotenv

description: Path to file or list of files containing runtime-created variables for this job.


key: lsif

description: Path to file or list of files containing code intelligence (Language Server Index Format).


key: sast

description: Path to file or list of files with SAST vulnerabilities report(s).


Path to file or list of files with Dependency scanning vulnerabilities report(s).


Path to file or list of files with Container scanning vulnerabilities report(s).


key: dast

description: Path to file or list of files with DAST vulnerabilities report(s).


Deprecated in 12.8: Path to file or list of files with license report(s).


Path to file or list of files with license report(s).


key: requirements

description: Path to file or list of files with requirements report(s).


Path to file or list of files with secret detection report(s).


key: metrics

description: Path to file or list of files with custom metrics report(s).


key: terraform

description: Path to file or list of files with terraform plan(s).


description: Will infer the method based on the value. E.g. `https://...` strings will be of type `include:remote`, and `/templates/...` or `templates/...` will be of type `include:local`.

format: uri-reference


key: local

description: Relative path from local repository root (`/`) to the `yaml`/`yml` file template. The file must be on the same branch, and does not work across git submodules.


key: project

description: Path to the project, e.g. `group/project`, or `group/sub-group/project` [Learn more](https://docs.gitlab.com/ee/ci/yaml/index.html#includefile).


key: ref

description: Branch/Tag/Commit-hash for the target project.


key: file

description: Relative path from project root (`/`) to the `yaml`/`yml` file template.


description: List of files by relative path from project root (`/`) to the `yaml`/`yml` file template.


key: template

description: Use a `.gitlab-ci.yml` template as a base, e.g. `Nodejs.gitlab-ci.yml`.


key: component

description: Local path to component directory or full path to external component directory.


key: remote

description: URL to a `yaml`/`yml` template file using HTTP/HTTPS.


key: image

description: Full name of the image that should be used. It should contain the Registry part if needed.


description: Specifies the docker image to use for the job or globally for all jobs. Job configuration takes precedence over global setting. Requires a certain kind of Gitlab runner executor.

default: always

enum: always never if-not-present


key: name


key: entrypoint

description: Command or script that should be executed as the container's entrypoint. It will be translated to Docker's --entrypoint option while creating the container. The syntax is similar to Dockerfile's ENTRYPOINT directive, where each shell token is a separate string in the array.


key: items


key: token

description: Specifies the JWT variable that should be used to authenticate with Hashicorp Vault.


key: paths

description: List of file paths.


description: Ref for comparing changes.


key: job

description: Name of a job that is defined in the pipeline.


key: artifacts

description: Download artifacts of the job in needs.


key: optional

description: Whether the job needs to be present in the pipeline to run ahead of the current job.


description: Setting this option to true will allow the job to fail while still letting the pipeline pass.


description: Exit code that are not considered failure. The job fails for any other exit code.


description: You can list which exit codes are not considered failures. The job fails for any other exit code.


key: parallel

description: Splits up a single job into multiple that run in parallel. Provides `CI_NODE_INDEX` and `CI_NODE_TOTAL` environment variables to the jobs.

type: string number array


description: Creates N instances of the job that run in parallel.


key: matrix

description: Defines different variables for jobs that are running in parallel.


description: Defines the variables for a specific job.


description: Use the `needs:parallel:matrix` keyword to specify parallelized jobs needed to be completed for the job to run. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#needsparallelmatrix)


description: Filter job by different keywords that determine origin or state, or by supplying string/regex to check against branch/tag names.


description: When a branch is pushed.


description: When a tag is pushed.


description: When a pipeline has been triggered by a second pipelines API (not triggers API).


description: When using CI services other than Gitlab


description: For multi-project triggers, created using the API with 'CI_JOB_TOKEN'.


description: Pipeline is triggered by a `git push` by the user


description: For scheduled pipelines.


description: For pipelines created using a trigger token.


description: For pipelines created using *Run pipeline* button in Gitlab UI (under your project's *Pipelines*).


description: String or regular expression to match against tag or branch names.


key: kubernetes

description: Filter job based on if Kubernetes integration is active.


key: changes

description: Filter job creation based on files that were modified in a git push.


description: The number of times the job will be retried if it fails. Defaults to 0 and can max be retried 2 times (3 times total).


description: Retry on any failure (default).

const: always


Retry when the failure reason is unknown.


Retry when the script failed.


Retry on API failure.


Retry when the job got stuck or timed out.


Retry if there is a runner system failure (for example, job setup failed).


Retry if the runner is unsupported.


Retry if a delayed job could not be executed.


Retry if the script exceeded the maximum execution time set for the job.


Retry if the job is archived and can’t be run.


Retry if the job failed to complete prerequisite tasks.


Retry if the scheduler failed to assign the job to a runner.


Retry if there is a structural integrity problem detected.


key: stage

description: Define what stage the job will run in.


key: only

description: Job will run *only* when these filtering options match.


key: extends

description: The name of one or more jobs to inherit configuration from.


key: needs

description: The list of jobs in previous stages whose sole completion is needed to start the current job.

required: job pipeline

required: job project ref


key: except

description: Job will run *except* for when these filtering options match.


key: dependencies

description: Specify a list of job names from earlier stages from which artifacts should be loaded. By default, all previous artifacts are passed. Use an empty array to skip downloading artifacts.


key: environment

description: Used to associate environment metadata with a deploy. Environment can have a name and URL attached to it, and will be displayed under /environments under the project.

format: uri

enum: start prepare stop verify access

default: start

enum: production staging testing development other


key: name

description: The name of the environment, e.g. 'qa', 'staging', 'production'.


key: url

description: When set, this will expose buttons in various places for the current environment in Gitlab, that will take you to the defined URL.


description: The name of a job to execute when the environment is about to be stopped.


key: action

description: Specifies what this job will do. 'start' (default) indicates the job will start the deployment. 'prepare'/'verify'/'access' indicates this will not affect the deployment. 'stop' indicates this will stop the deployment.


description: The amount of time it should take before Gitlab will automatically stop the environment. Supports a wide variety of formats, e.g. '1 week', '3 mins 4 sec', '2 hrs 20 min', '2h20min', '6 mos 1 day', '47 yrs 6 mos and 4d', '3 weeks and 2 days'.


description: Used to configure the kubernetes deployment for this environment. This is currently not supported for kubernetes clusters that are managed by Gitlab.


key: namespace

description: The kubernetes namespace where this environment should be deployed to.


description: Explicitly specifies the tier of the deployment environment if non-standard environment name is used.


key: release

description: Indicates that the job creates a Release.

format: date-time

enum: runbook package image other

required: name url


description: The tag_name must be specified. It can refer to an existing Git tag or can be specified by the user.


description: Message to use if creating a new annotated tag.


key: description

description: Specifies the longer description of the Release.


description: The Release name. If omitted, it is populated with the value of release: tag_name.


key: ref

description: If the release: tag_name doesn’t exist yet, the release is created from ref. ref can be a commit SHA, another tag name, or a branch name.


key: milestones

description: The title of each milestone the release is associated with.


description: The date and time when the release is ready. Defaults to the current date and time if not defined. Should be enclosed in quotes and expressed in ISO 8601 format.


key: links

description: Include asset links in the release.


description: The name of the link.


description: The URL to download a file.


key: filepath

description: The redirect link to the url.


description: The content kind of what users can download via url.


key: coverage

description: Must be a regular expression, optionally but recommended to be quoted, and must be surrounded with '/'. Example: '/Code coverage: \d+\.\d+/'

format: regex


description: Limit job concurrency. Can be used to ensure that the Runner will not run certain jobs simultaneously.


key: project

description: Path to the project, e.g. `group/project`, or `group/sub-group/project`.


key: branch

description: The branch name that a downstream pipeline will use


key: strategy

description: You can mirror the pipeline status from the triggered pipeline to the source bridge job by using strategy: depend


key: forward

description: Specify what to forward to the downstream pipeline.


description: Variables defined in the trigger job are passed to downstream pipelines.


description: Variables added for manual pipeline runs and scheduled pipelines are passed to downstream pipelines.


key: trigger

description: Trigger a child pipeline. [Learn More](https://docs.gitlab.com/ee/ci/pipelines/parent_child_pipelines.html).

required: artifact job

required: project file


key: include

description: Relative path from local repository root (`/`) to the local YAML file to define the pipeline configuration.


description: References a local file or an artifact from another job to define the pipeline configuration.


key: local


key: template

description: Name of the template YAML file to use in the pipeline configuration.


key: artifact

description: Relative path to the generated YAML file which is extracted from the artifacts and used as the configuration for triggering the child pipeline.


key: job

description: Job name which generates the artifact


description: Path to another private project under the same GitLab instance, like `group/project` or `group/sub-group/project`.


description: Branch/Tag/Commit hash for the target project.


key: file

description: Relative path from repository root (`/`) to the pipeline configuration YAML file.


key: publish

description: A path to a directory that contains the files to be published with Pages


description: A JSON schema describing a .mocharc.[json|yml|yaml] file


description: JSON Schema definition for the Embrace configuration file.


description: Your 5 character app ID.


description: Your API 32-hexdigit token.


description: Enables NDK crash capture. Defaults to false.


description: The SDK collects the disk usage for the app. You can disable this if your app has a large number of local files to prevent excessive resource usage, especially on lower-end devices. Defaults to true.


key: enabled

description: Set to false to prevent the SDK from connecting to the uncaught exception handler. Defaults to true.


description: Disable capture of network length which can interfere with certain streaming network requests. Defaults to true.


description: Specify one or more regular expressions to exclude network request with URLs matching one of the regular expressions from being captured.


description: Enable capture of network requests made using the native Java network API. Defaults to true.


description: Set the name of the header used for the trace ID. Defaults to 'x-emb-trace-id'.


description: Send the session end message asynchronously. Defaults to false.


description: Enable automatic ending of sessions every N seconds. This is only recommended for applications, such as kiosks, where the app is never expected to go to the background. This value must be 60 seconds or greater if set.


description: Control whether the startup moment is automatically ended. Defaults to true.


description: Control whether screenshots are taken during the startup moment. Defaults to false.


description: Set to false to disable capturing tap coordinates. Defaults to true.


description: Set to false to disable capturing of web view query parameters. Defaults to true. If webview:enable is set to false, this setting has no effect since all capture of web view information is disabled.


key: enable

description: Set to false to disable capturing of web views. Defaults to true.


key: pre-if

description: Allows you to define conditions for the `pre:` action execution. The `pre:` action will only run if the conditions in `pre-if` are met. If not set, then `pre-if` defaults to `always()`. Note that the `step` context is unavailable, as no steps have run yet.


key: post-if

description: Allows you to define conditions for the `post:` action execution. The `post:` action will only run if the conditions in `post-if` are met. If not set, then `post-if` defaults to `always()`.


key: runs-javascript

description: Configures the path to the action's code and the application used to execute the code.

required: using main


key: using

description: The application used to execute the code specified in `main`.


key: main

description: The file that contains your action code. The application specified in `using` executes this file.


key: pre

description: Allows you to run a script at the start of a job, before the `main:` action begins. For example, you can use `pre:` to run a prerequisite setup script. The application specified with the `using` syntax will execute this file. The `pre:` action always runs by default but you can override this using `pre-if`.


key: post

description: Allows you to run a script at the end of a job, once the `main:` action has completed. For example, you can use `post:` to terminate certain processes or remove unneeded files. The application specified with the `using` syntax will execute this file. The `post:` action always runs by default but you can override this using `post-if`.


key: runs-composite

description: Configures the path to the composite action, and the application used to execute the code.

const: composite

enum: bash pwsh python sh cmd powershell

required: run shell

required: using steps


description: To use a composite run steps action, set this to 'composite'.


key: steps

description: The run steps that you plan to run in this action.


key: run

description: The command you want to run. This can be inline or a script in your action repository.


key: shell

description: The shell where you want to run the command.


key: uses

description: Selects an action to run as part of a step in your job.


key: with

description: A map of the input parameters defined by the action. Each input parameter is a key/value pair. Input parameters are set as environment variables. The variable is prefixed with INPUT_ and converted to upper case.


key: name

description: The name of the composite run step.


key: id

description: A unique identifier for the step. You can use the `id` to reference the step in contexts.


key: if

description:
You can use the if conditional to prevent a step from running unless a condition is met. You can use any supported context and expression to create a conditional.
Expressions in an if conditional do not require the ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.


key: env

description: Sets a map of environment variables for only that step.


key: continue-on-error

description: Prevents a job from failing when a step fails. Set to true to allow a job to pass when this step fails.


key: working-directory

description: Specifies the working directory where the command is run.


key: runs-docker

description: Configures the image used for the Docker action.

const: docker

type: number

required: using image


key: using

description: You must set this value to 'docker'.


key: image

description: The Docker image to use as the container to run the action. The value can be the Docker base image name, a local `Dockerfile` in your repository, or a public image in Docker Hub or another registry. To reference a `Dockerfile` local to your repository, use a path relative to your action metadata file. The `docker` application will execute this file.


description: Specifies a key/value map of environment variables to set in the container environment.


key: entrypoint

description: Overrides the Docker `ENTRYPOINT` in the `Dockerfile`, or sets it if one wasn't already specified. Use `entrypoint` when the `Dockerfile` does not specify an `ENTRYPOINT` or you want to override the `ENTRYPOINT` instruction. If you omit `entrypoint`, the commands you specify in the Docker `ENTRYPOINT` instruction will execute. The Docker `ENTRYPOINT instruction has a *shell* form and *exec* form. The Docker `ENTRYPOINT` documentation recommends using the *exec* form of the `ENTRYPOINT` instruction.


key: pre-entrypoint

description: Allows you to run a script before the `entrypoint` action begins. For example, you can use `pre-entrypoint:` to run a prerequisite setup script. GitHub Actions uses `docker run` to launch this action, and runs the script inside a new container that uses the same base image. This means that the runtime state is different from the main `entrypoint` container, and any states you require must be accessed in either the workspace, `HOME`, or as a `STATE_` variable. The `pre-entrypoint:` action always runs by default but you can override this using `pre-if`.


key: post-entrypoint

description: Allows you to run a cleanup script once the `runs.entrypoint` action has completed. GitHub Actions uses `docker run` to launch this action. Because GitHub Actions runs the script inside a new container using the same base image, the runtime state is different from the main `entrypoint` container. You can access any state you need in either the workspace, `HOME`, or as a `STATE_` variable. The `post-entrypoint:` action always runs by default but you can override this using `post-if`.


key: args

description:
An array of strings that define the inputs for a Docker container. Inputs can include hardcoded strings. GitHub passes the `args` to the container's `ENTRYPOINT` when the container starts up.
The `args` are used in place of the `CMD` instruction in a `Dockerfile`. If you use `CMD` in your `Dockerfile`, use the guidelines ordered by preference:
- Document required arguments in the action's README and omit them from the `CMD` instruction.
- Use defaults that allow using the action without specifying any `args`.
- If the action exposes a `--help` flag, or something similar, use that to make your action self-documenting.


key: outputs

description:
Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input.
If you don't declare an output in your action metadata file, you can still set outputs and use them in a workflow.


description: A string identifier to associate with the output. The value of `<output_id>` is a map of the output's metadata. The `<output_id>` must be a unique identifier within the outputs object. The `<output_id>` must start with a letter or `_` and contain only alphanumeric characters, `-`, or `_`.


key: description

description: A string description of the output parameter.


key: outputs-composite

required: description value


key: value

description: The value that the output parameter will be mapped to. You can set this to a string or an expression with context. For example, you can use the steps context to set the value of an output to the output value of a step.


key: name

description: The name of your action. GitHub displays the `name` in the Actions tab to help visually identify actions in each job.


key: author

description: The name of the action's author.


description: A short description of the action.


key: inputs

description: Input parameters allow you to specify data that the action expects to use during runtime. GitHub stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids.


description: A string identifier to associate with the input. The value of `<input_id>` is a map of the input's metadata. The `<input_id>` must be a unique identifier within the inputs object. The `<input_id>` must start with a letter or `_` and contain only alphanumeric characters, `-`, or `_`.


description: A string description of the input parameter.


key: deprecationMessage

description: A string shown to users using the deprecated input.


key: required

description: A boolean to indicate whether the action requires the input parameter. Set to `true` when the parameter is required.


key: default

description: A string representing the default value. The default value is used when an input parameter isn't specified in a workflow file.


key: branding

description: You can use a color and Feather icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in GitHub Marketplace.

enum: white yellow blue green orange red purple gray-dark

enum: activity airplay alert-circle alert-octagon alert-triangle align-center align-justify align-left align-right anchor aperture archive arrow-down-circle arrow-down-left arrow-down-right arrow-down arrow-left-circle arrow-left arrow-right-circle arrow-right arrow-up-circle arrow-up-left arrow-up-right arrow-up at-sign award bar-chart-2 bar-chart battery-charging battery bell-off bell bluetooth bold book-open book bookmark box briefcase calendar camera-off camera cast check-circle check-square check chevron-down chevron-left chevron-right chevron-up chevrons-down chevrons-left chevrons-right chevrons-up circle clipboard clock cloud-drizzle cloud-lightning cloud-off cloud-rain cloud-snow cloud code command compass copy corner-down-left corner-down-right corner-left-down corner-left-up corner-right-down corner-right-up corner-up-left corner-up-right cpu credit-card crop crosshair database delete disc dollar-sign download-cloud download droplet edit-2 edit-3 edit external-link eye-off eye facebook fast-forward feather file-minus file-plus file-text file film filter flag folder-minus folder-plus folder gift git-branch git-commit git-merge git-pull-request globe grid hard-drive hash headphones heart help-circle home image inbox info italic layers layout life-buoy link-2 link list loader lock log-in log-out mail map-pin map maximize-2 maximize menu message-circle message-square mic-off mic minimize-2 minimize minus-circle minus-square minus monitor moon more-horizontal more-vertical move music navigation-2 navigation octagon package paperclip pause-circle pause percent phone-call phone-forwarded phone-incoming phone-missed phone-off phone-outgoing phone pie-chart play-circle play plus-circle plus-square plus pocket power printer radio refresh-ccw refresh-cw repeat rewind rotate-ccw rotate-cw rss save scissors search send server settings share-2 share shield-off shield shopping-bag shopping-cart shuffle sidebar skip-back skip-forward slash sliders smartphone speaker square star stop-circle sun sunrise sunset tablet tag target terminal thermometer thumbs-down thumbs-up toggle-left toggle-right trash-2 trash trending-down trending-up triangle truck tv type umbrella underline unlock upload-cloud upload user-check user-minus user-plus user-x user users video-off video voicemail volume-1 volume-2 volume-x volume watch wifi-off wifi wind x-circle x-square x zap-off zap zoom-in zoom-out


key: color

description: The background color of the badge.


key: icon

description: The name of the Feather icon to use.


key: type

description: Control type

enum: tabs panel


key: $schema

description: Specify a JSON schema


description: If translations will be provided via files, e.g. in admin/i18n/de/translations.json or provide the path to the i18n folder if it's custom or provide the translations inside this attribute as an object


key: items

description: Consists of objects representing e.g. a single tab

const: language

required: type system

const: autocompleteSendTo

required: type command

const: selectSendTo

const: textSendTo

const: header

required: type size text

const: color

const: divider

enum: primary secondary

const: icon

const: panel

required: type items

const: image

const: sendTo

enum: contained outlined

const: password

const: file

required: type filename

const: slider

const: custom

const: checkbox

const: number

const: autocomplete

required: type options

const: text

enum: state channel device enum host adapter instance meta config script user group chart folder

enum: autocomplete text number color checkbox chips header slider ip user room func select icon image panel password file sendTo staticText custom pattern table instance language setState certificate staticImage staticLink divider objectId selectSendTo autocompleteSendTo checkLicense uuid


description: Object representing e.g. a tab

const: language

const: autocompleteSendTo

const: selectSendTo

const: select


key: system

description: Allow the usage of the system language from system.config as default


key: command

description: Command to be sent.


key: jsonData

description: Data to be sent as parsable string, can contain special placeholder. E. g. '{"subject1": "${data.subject}", "options1": {"host": "${data.host}"}}'


key: data

description: Data to be sent as JSON.


key: freeSolo

description: Set freeSolo to true so the textbox can contain any arbitrary value.


key: placeholder

description: Placeholder (for text control)


key: manual

description: Allow manual editing. Without Dropdown


key: container

description: div, text


key: copyToClipboard

description: If true, show button


key: alsoDependsOn

description: Depends on other attributes and will be re-calculated when other attributes changed


key: size

description: Size of the header: h1-h5


key: text

description: Header text


key: color

description: Optional color


key: height

description: Optional height


key: crop

description: If true, allow user to crop the image (only for non svg)


key: square

description: Width must be equal to height or crop must allow only square as shape


key: maxWidth

description: Maximum width


key: maxHeight

description: Maximum height


key: maxSize

description: Maximum size


key: icon

description: Panel can have icon (base64)


key: accept

description: HTML accept attribute, like 'image/*,.pdf'


description: 'Maximum width


description: 'Maximum height


description: 'Maximum size


key: filename

description: Name of the file


key: command

description: Command to be sent.


description: sendTo can have icon (base64)


key: jsonData


key: data

description: Data to be sent as JSON.


key: result

description: {result1: {en: 'A'}, result2: {en: 'B'}}


key: error

description: {error1: {en: 'E'}, error2: {en: 'E2'}}


key: variant

description: If outlined or contained


key: placeholder

description: Placeholder (for text control)


key: useNative

description: if adapter returns result with `native` attribute it will be used for configuration. If `saveConfig` is true, the user will be requested to save the configuration


key: showProcess

description: Show spinner while request is in progress


key: encrypted

description: Is value encrypted or not (of course only for texts)


key: repeat

description: Password must be compared with password


key: visible

description: True if allow to view the password by toggling the view button


key: min

description: Minimal value


key: max

description: Maximum number


key: step

description: Step size


key: component

description: Component name that will be provided via props, like componentInstancesEditor


key: freeSolo


key: options

description: Options which can be completed. ["value1", "value2", ...] or [{"value": "value", "label": "Value1"}, "value2", ...]


key: text

description: Text input


key: trim

description: If text must be trimmed or not (default = true)


key: minRows

description: default is 1. Set this attribute to `2` or more if you want to have a textarea with more than one row


key: maxRows

description: max rows of textarea. Used only if `minRows` > 1


description: Options which can be selected

required: label value


key: label

description: Label


key: value

description: Value


key: hidden

description: JS function that could use `native.attribute` for calculation


key: noDelete

description: If delete or add disabled, If noDelete is false, add, delete and move up/down should work


key: items

description: Items of the table

required: type attr width title

const: textSendTo

const: header

const: color

const: divider


key: system

description: Allow the usage of the system language from system.config as default


key: command

description: Command to be sent.


key: jsonData

description: Data to be sent as parsable string, can contain special placeholder. E. g. '{"subject1": "${data.subject}", "options1": {"host": "${data.host}"}}'


key: data

description: Data to be sent as JSON.


key: placeholder

description: Placeholder (for text control)


key: manual

description: Allow manual editing. Without Dropdown


key: container

description: div, text


key: copyToClipboard

description: If true, show button


key: alsoDependsOn

description: Depends on other attributes and will be re-calculated when other attributes changed


key: size

description: Size of the header: h1-h5


key: text

description: Header text


key: color

description: Optional color


key: height

description: Optional height


key: crop

description: If true, allow user to crop the image (only for non svg)


key: square

description: Width must be equal to height or crop must allow only square as shape


key: maxWidth

description: Maximum width


key: maxHeight

description: Maximum height


key: maxSize

description: Maximum size


key: icon

description: Panel can have icon (base64)


key: accept

description: HTML accept attribute, like 'image/*,.pdf'


description: 'Maximum width


description: 'Maximum height


description: 'Maximum size


key: filename

description: Name of the file


key: command

description: Command to be sent.


description: sendTo can have icon (base64)


key: jsonData


key: data

description: Data to be sent as JSON.


key: result

description: {result1: {en: 'A'}, result2: {en: 'B'}}


key: error

description: {error1: {en: 'E'}, error2: {en: 'E2'}}


key: variant

description: If outlined or contained


key: placeholder

description: Placeholder (for text control)


key: useNative

description: if adapter returns result with `native` attribute it will be used for configuration. If `saveConfig` is true, the user will be requested to save the configuration


key: showProcess

description: Show spinner while request is in progress


key: encrypted

description: Is value encrypted or not (of course only for texts)


key: repeat

description: Password must be compared with password


key: visible

description: True if allow to view the password by toggling the view button


key: min

description: Minimal value


key: max

description: Maximum number


key: step

description: Step size


key: component

description: Component name that will be provided via props, like componentInstancesEditor


key: freeSolo

description: Set freeSolo to true so the textbox can contain any arbitrary value.


key: options

description: Options which can be completed. ["value1", "value2", ...] or [{"value": "value", "label": "Value1"}, "value2", ...]


key: text

description: Text input


key: trim

description: If text must be trimmed or not (default = true)


key: minRows

description: default is 1. Set this attribute to `2` or more if you want to have a textarea with more than one row


key: maxRows

description: max rows of textarea. Used only if `minRows` > 1


description: Options which can be selected


key: label

description: Label


key: value

description: Value


key: hidden

description: JS function that could use `native.attribute` for calculation


key: pattern

description: Read-only field with pattern like 'https://${data.ip}:${data.port}' (will not be saved in config)


key: copyToClipboard

description: If true, show copy button.


key: color

description: Optional color


key: icon

description: setState can have icon (base64)


key: id

description: State ID, e.g. 'info.test'


key: ack

description: ack-flag of the state


key: val

description: State value to set


key: okText

description: Alert that will be shown by pressing the button


key: error

description: {error1: {en: 'E'}, error2: {en: 'E2'}}


key: variant

description: If outlined or contained


key: short

description: no system.func.


description: no system.room.


description: no system.user.


key: listenOnAllPorts

description: Add 0.0.0.0 to option


description: Show only IP4 addresses


description: Show only IP6 addresses


key: certType

description: Type of the certificate

enum: public private chained


key: href

description: Link


key: text

description: Static link or button


description: icon for button


description: Static text like description


key: adapter

description: Name of the adapter. With special name _dataSources you can get all adapters with flag common.getHistory


key: all

description: Add to the options ALL option with value *


key: src

description: Name of picture (from admin directory)


key: delimiter

description: Delimiter for options. If no delimiter, the setting will be stored as array


key: types

description: Array of possible types: ['channel', 'device', ...] (has only state by default)


key: placeholder

description: Placeholder (for text control)


key: uuid

description: If UUID must be checked too


key: version

description: Check version


key: label

description: Label of tab


key: sm

description: Width in 1/12 of screen on small screen


key: md

description: width in 1/12 of screen on middle screens


key: lg

description: width in 1/12 of screen on large screens


key: xs

description: width in 1/12 of screen on very small screens


key: newLine

description: Should be shown from new line


key: hidden

description: JS function that could use 'native.attribute' for calculation


key: hideOnlyControl

description: If hidden the place will be shown, but no control


key: disabled


key: helpLink

description: href to help


key: style

description: css style in react notation: 'radiusBorder' and not 'radius-border'


key: darkStyle

description: css style for dark mode


key: validator

description: JS function: true no error, false - error


key: validatorNoSaveOnError

description: True if save must be disabled by errors


key: validatorErrorText

description: Text to show if validator fails


key: showSecondAddAt

description: Number of lines from which the second add button at the bottom of the table will be shown. Default 5


key: tooltip

description: Optional tooltip


key: default

description: Default value


key: calculateFunc

description: JS function: that calculates value


key: ignoreOwnChanges

description: Do not trigger onChange event if changed value of this attribute


key: alsoDependsOn

description: Depends on other attributes and will be re-calculated when other attributes changed


key: defaultFunc

description: JS function to calculate default value


key: func

description: JS function: that calculates value


key: noTranslation

description: Do not translate selects or other options (not for help, label or placeholder)


key: confirm

description: Confirm dialog

enum: info warning error none


key: condition

description: JS function: true show confirm dialog


key: text

description: Text of confirmation dialog


key: title

description: Title of confirmation dialog


key: ok

description: Text for 'OK' button


key: cancel

description: Text for 'cancel' button


description: Trigger confirm dialog if on of the components changed.


key: noMultiEdit

description: (only custom) if this flag set to true, this field will not be shown if user selected more than one object for edit


key: maxLength

description: max length of text in field


key: button

description: show link as button


key: pattern

description: Read-only field with pattern like 'https://${data.ip}:${data.port}' (will not be saved in config)


key: copyToClipboard

description: If true, show copy button.


key: color

description: Optional color


key: icon

description: setState can have icon (base64)


key: id

description: State ID, e.g. 'info.test'


key: ack

description: ack-flag of the state


key: val

description: State value to set


key: okText

description: Alert that will be shown by pressing the button


key: error

description: {error1: {en: 'E'}, error2: {en: 'E2'}}


key: variant

description: If outlined or contained


key: short

description: no system.func.


description: no system.room.


description: no system.user.


key: listenOnAllPorts

description: Add 0.0.0.0 to option


description: Show only IP4 addresses


description: Show only IP6 addresses


key: certType

description: Type of the certificate


key: href

description: Link


key: text

description: Static link or button


description: icon for button


description: Static text like description


key: adapter

description: Name of the adapter. With special name _dataSources you can get all adapters with flag common.getHistory


key: all

description: Add to the options ALL option with value *


key: src

description: Name of picture (from admin directory)


key: delimiter

description: Delimiter for options. If no delimiter, the setting will be stored as array


key: types

description: Array of possible types: ['channel', 'device', ...] (has only state by default)


key: placeholder

description: Placeholder (for text control)


key: uuid

description: If UUID must be checked too


key: version

description: Check version


key: label

description: Label of tab


key: type

description: Type of the element


key: sm

description: Width in 1/12 of screen on small screen


key: md

description: width in 1/12 of screen on middle screens


key: lg

description: width in 1/12 of screen on large screens


key: xs

description: width in 1/12 of screen on very small screens


key: newLine

description: Should be shown from new line


key: hidden

description: JS function that could use 'native.attribute' for calculation


key: hideOnlyControl

description: If hidden the place will be shown, but no control


key: disabled


key: helpLink

description: href to help


key: style

description: css style in react notation: 'radiusBorder' and not 'radius-border'


key: darkStyle

description: css style for dark mode


key: validator

description: JS function: true no error, false - error


key: validatorNoSaveOnError

description: True if save must be disabled by errors


key: validatorErrorText

description: Text to show if validator fails


key: showSecondAddAt

description: Number of lines from which the second add button at the bottom of the table will be shown. Default 5


key: tooltip

description: Optional tooltip


key: default

description: Default value


key: calculateFunc

description: JS function: that calculates value


key: ignoreOwnChanges

description: Do not trigger onChange event if changed value of this attribute


key: alsoDependsOn

description: Depends on other attributes and will be re-calculated when other attributes changed


key: defaultFunc

description: JS function to calculate default value


key: func

description: JS function: that calculates value


key: noTranslation

description: Do not translate selects or other options (not for help, label or placeholder)


key: confirm

description: Confirm dialog


key: condition

description: JS function: true show confirm dialog


key: text

description: Text of confirmation dialog


key: title

description: Title of confirmation dialog


key: ok

description: Text for 'OK' button


key: cancel

description: Text for 'cancel' button


description: Trigger confirm dialog if on of the components changed.


key: noMultiEdit

description: (only custom) if this flag set to true, this field will not be shown if user selected more than one object for edit


key: maxLength

description: max length of text in field


key: button

description: show link as button


default: host

examples: host private

enum: private host

default: private

examples: shareable private

enum: shareable private

default: containerd

examples: runc containerd

cache-disabled: false

cache-compress: true

env: os,customer

labels: somelabel


key: sources

description: Includes information regarding all sources that have been added to SideWaffle.


key: Name

description: The name of the source.


key: Enabled

description: Indicates whether the source template(s) should be added to Visual Studio.


key: Location

description: The location of the source to be added. This can be on a git repository or local file share.


key: Branch

description: The branch of the source repository containing the template.


key: updateInterval

description: Used by SideWaffle to determine how often Visual Studio will download and install the templates from its source.

enum: Always OnceADay OnceAWeek OnceAMonth Never


key: IsEncrypted

description: When this setting is set to true, all values are encrypted with a local machine key. Used with func settings commands. Default value is false. You might want to encrypt the local.settings.json file on your local computer when it contains secrets, such as service connection strings. The host automatically decrypts settings when it runs. Use the func settings decrypt command before trying to read locally encrypted settings.


key: Values

description: Application settings and connection strings used when a project is running locally. These key-value (string-string) pairs correspond to application settings in your function app in Azure, like AzureWebJobsStorage. Many triggers and bindings have a property that refers to a connection string app setting, like Connection for the Blob storage trigger. For these properties, you need an application setting defined in the Values array. See the subsequent table for a list of commonly used settings. Values must be strings and not JSON objects or arrays. Setting names can't include a colon (:) or a double underline (__). Double underline characters are reserved by the runtime, and the colon is reserved to support dependency injection.

enum: custom dotnet dotnet-isolated node java powershell python


description: Indicates the targeted language of the Functions runtime. Required for version 2.x and higher of the Functions runtime. This setting is generated for your project by Core Tools. To learn more, see the FUNCTIONS_WORKER_RUNTIME reference.


key: AzureWebJobsStorage

description: Contains the connection string for an Azure storage account. Required when using triggers other than HTTP. For more information, see the AzureWebJobsStorage reference. When you have the Azure storage emulator installed locally and you set AzureWebJobsStorage to UseDevelopmentStorage=true, Core Tools uses the emulator. The emulator is useful during development, but you should test with an actual storage connection before deployment.


key: AzureWebJobsDashboard

description: DEPRECATED. Legacy Storage connection string for storing logs. May impact performance and increase Storage transactions/costs.


description: Indicates that PowerShell 7 be used when running locally. If not set, then PowerShell Core 6 is used. This setting is only used when running locally. When running in Azure, the PowerShell runtime version is determined by the powerShellVersion site configuration setting, which can be set in the portal.


key: Host

description: Settings in this section customize the Functions host process when you run projects locally. These settings are separate from the host.json settings, which also apply when you run projects in Azure.


key: LocalHttpPort


key: CORS

description: Defines the origins allowed for cross-origin resource sharing (CORS). Origins are supplied as a comma-separated list with no spaces. The wildcard value (*) is supported, which allows requests from any origin.


key: CORSCredentials

description: When set to true, allows withCredentials requests.


key: ConnectionStrings

description: A collection. Don't use this collection for the connection strings used by your function bindings. This collection is used only by frameworks that typically get connection strings from the ConnectionStrings section of a configuration file, like Entity Framework. Connection strings in this object are added to the environment with the provider type of System.Data.SqlClient. Items in this collection aren't published to Azure with other app settings. You must explicitly add these values to the Connection strings collection of your function app settings. If you're creating a SqlConnection in your function code, you should store the connection string value with your other connections in Application Settings in the portal.


description: Configurations for the appearance of nodes in the dbt documentation.


description: The color of the node on the DAG in the documentation. It must be an Hex code or a valid CSS color name.


description: Configurations specific to BigQuery adapter used to add labels and tags to tables & views created by dbt.


description: Configurations set in the dbt_project.yml file will apply to all metrics that don't have a more specific configuration set.


description: Configurations set in the dbt_project.yml file will apply to all models that don't have a more specific configuration set.


description: Configurations for the persistence of the dbt documentation.


description: Configurations set in the dbt_project.yml file will apply to all tests that don't have a more specific configuration set.


description: Configuration, specific to BigQuery adapter, used to setup authorized views.


description: Configuration specific to BigQuery adapter used to set an expiration delay (in hours) to a table.


description: Configuration, specific to BigQuery adapter, of the KMS key name used for data encryption.


key: cmdline

description: Extra parameters passed to the corresponding command


key: help

description: Help options for ansible-config command in stdout mode


key: path

description: Specify the path to the ansible configuration file


description: Help options for ansible-doc command in stdout mode


key: name

description: Specify the plugin name


key: type

description: Specify the plugin type, 'become', 'cache', 'callback', 'cliconf', 'connection', 'filter', 'httpapi', 'inventory', 'keyword', 'lookup', 'module', 'netconf', 'role', 'shell', 'strategy', 'test' or 'vars'

default: module

enum: become cache callback cliconf connection filter httpapi inventory keyword lookup module netconf role shell strategy test vars


key: entries

description: Specify an inventory file path or comma separated host list


description: Help options for ansible-inventory command in stdout mode


description: Help options for ansible-playbook command in stdout mode


description: Specify the playbook name


description: Help options for ansible-builder command in stdout mode


key: workdir

description: Specify the path that contains ansible-builder manifest files


key: config

description: Specify the path to the ansible-lint configuration file


key: lintables

description: Path to files on which to run ansible-lint


key: artifact-dir

description: The directory path to store artifacts generated by ansible-runner


key: job-events

description: Write ansible-runner job_events in the artifact directory


key: rotate-artifacts-count

description: Keep ansible-runner artifact directories, for last n runs, if set to 0 artifact directories won't be deleted


key: timeout

description: The timeout value after which ansible-runner will forcefully stop the execution


key: app

description: Subcommands

default: welcome

enum: builder collections config doc exec images inventory lint replay run settings welcome


key: collection-doc-cache-path

description: The path to collection doc cache


key: enable

description: Enable the use of color for mode interactive and stdout


description: Enable or disable terminal color changing support with OSC 4


key: command

description: Specify the editor command

default: vi +{line_number} {filename}


key: console

description: Specify if the editor is console based


key: enable-prompts

description: Enable prompts for password and in playbooks. This will set mode to stdout and disable playbook artifact creation


description: Specify the command to run within the execution environment


key: shell

description: Specify the exec command should be run in a shell


key: container-engine

description: Specify the container engine (auto=podman then docker)

default: auto

enum: auto podman docker


key: container-options

description: Extra parameters passed to the container engine command


key: enabled

description: Enable or disable the use of an execution environment


key: pass

description: Specify an existing environment variable to be passed through to and set within the execution environment (--penv MY_VAR)


key: set

description: Specify an environment variable and a value to be set within the execution environment (--senv MY_VAR=42)


key: image

description: Specify the name of the execution environment image


key: arguments

description: Specify any additional parameters that should be added to the pull command when pulling an execution environment from a container registry. e.g. --pa='--tls-verify=false'


key: policy

description: Specify the image pull policy always:Always pull the image, missing:Pull if not locally available, never:Never pull the image, tag:if the image tag is 'latest', always pull the image, otherwise pull if not locally available

default: tag

enum: always missing never tag


key: volume-mounts

description: Specify volume to be bind mounted within an execution environment (--eev /home/user/test:/home/user/test:Z)

required: src dest


key: format

description: Specify the format for stdout output.

default: yaml

enum: json yaml


key: details

description: Provide detailed information about the selected execution environment image


key: inventory-columns

description: Specify a host attribute to show in the inventory view


key: append

description: Specify if log messages should be appended to an existing log file, otherwise a new log file will be created per session


key: file

description: Specify the full path for the ansible-navigator log file


key: level

description: Specify the ansible-navigator log level

default: warning

enum: debug info warning error critical


key: mode

description: Specify the user-interface mode

default: interactive

enum: stdout interactive


key: enable

description: Enable or disable the creation of artifacts for completed playbooks. Note: not compatible with '--mode stdout' when playbooks require user input


key: replay

description: Specify the path for the playbook artifact to replay


key: save-as

description: Specify the name for artifacts created from completed playbooks. The following placeholders are available: {playbook_dir}, {playbook_name}, {playbook_status}, and {time_stamp}


key: effective

description: Show the effective settings. Defaults, CLI parameters, environment variables, and the settings file will be combined


key: sample

description: Generate a sample settings file


key: schema

description: Generate a schema for the settings file ('json'= draft-07 JSON Schema)

default: json


key: sources

description: Show the source of each current settings entry


key: time-zone

description: Specify the IANA time zone to use or 'local' to use the system time zone

default: UTC


description:
An alias of the current directory
https://github.com/sebglazebrook/aliases#usage


key: command

description:
A command of the current alias
https://github.com/sebglazebrook/aliases#usage


key: confirm

description:
Whether to confirm a command execution of the current alias
https://github.com/sebglazebrook/aliases#usage


description:
A confirmation message of the current alias
https://github.com/sebglazebrook/aliases#usage


key: conditional

description:
A conditional of the current alias
https://github.com/sebglazebrook/aliases#usage


description:
A backout of the current alias
https://github.com/sebglazebrook/aliases#usage


description:
A unit test of the current alias
https://github.com/sebglazebrook/aliases#usage


key: quiet

description:
Whether to display a command before execution of the current alias
https://github.com/sebglazebrook/aliases#usage


key: description

description: In the relevant UI field, enter a description to be displayed to the user.


description: Configuration for safebox to deploy parameters to various parameter stores

enum: ssm secrets-manager

default: /<stage>/<service>/

required: type path

enum: json yaml dotenv types-node

required: service provider


key: service

description: Name of the service. parameters will be prefixed by the value provided


key: provider

description: Deploy parameters to the given provider. Eg. ssm, secrets-manager


key: region

description: Region to deploy the parameters to. Eg. us-east-1


key: prefix

description: Prefix to apply to all parameters. Does not apply for shared


key: generate

description: Generate different files based on the parameter name and values


key: type

description: Type of file to generate


key: path

description: Full path with filename for writing the output


key: cloudformation-stacks

description:
Cloudformation stack names. Any output values from the stacks can be interpolated. Eg. DB_NAME: "{{.myDbName}}"
myDbName is the output of one of the cloudformation stacks


key: config

description: Parameters to deploy as non secret. You can also specify stage specific key value pairs. Same key in the defaults will be ignored and stage specific value will be used.


key: defaults

description: parameter name and value. Output is /<stage>/<service>/<param name>


key: shared

description: Params that are to be shared between multiple services. The parameter name wont be prefixed by service name. Output is /<stage>/shared/<param name>


key: secret

description: Parameters to deploy as secret. You cannot specify stage specific key value pairs. Value is the description. You will need to run safebox deploy in prompt mode to provide the actual value.


description: An object hash containing an `items` array and optionally a `config` object

enum: --- npmversion npmdownloads daviddm daviddmdev nodeico saucelabsbm saucelabs travisci githubworkflow codeship coveralls codeclimate bithound waffle sixtydevstips patreon opencollective gratipay flattr paypal bitcoin wishlist slackinscript slackin gabeacon googleplusone redditsubmit hackernewssubmit facebooklike facebookfollow twittertweet twitterfollow githubfollow githubstar quorafollow


key: list

description: Array of badges. Use "---" to denote a separation.


description: Configuration object


key: npmPackageName

description: The npm package name


key: saucelabsUsername

description: The username of the SauceLabs account


key: saucelabsAuthToken

description:
SauceLabs auth token, should probably not be used.
Use `SAUCELABS_AUTH_TOKEN` env var instead.


key: travisTLD

description: The TLD to use for Travis CI. Use "com" if you have moved to travis-ci.com


key: codeshipProjectUUID

description: The UUID for the project, available in the General tab of your project setting.


key: codeshipProjectID

description: The ID for the project, available in the URL for the codeship project.


key: githubSlug

description: The Github slug of the project (e.g., SchemaStore/schemastore)


key: githubWorkflow

description: The name or location of the workflow file to show the badge for.


key: githubBranch

description: The branch to constrain the badge to.


key: githubEvent

description: The event to constrain the badge to.


key: nodeicoQueryString

description:
Either a query string as a string, or an object containing the options.

See https://nodei.co for details


key: sixtydevstipsID

description: The 60devs username to donate to.


key: sixtydevstipsURL

description: The URL to the 60devs donate page.


key: patreonUsername

description: The Patreon username to donate to.


key: patreonURL

description: The URL to the Patreon donate page.


key: opencollectiveUsername

description: The Open Collective username to donate to.


key: opencollectiveURL

description: The URL to the Open Collective donate page.


key: homepage

description: The home page URL


key: twitterUsername

description: The twitter username to tweet at


key: githubUsername

description: The Github username to use


description: yamllint uses a set of rules to check source files for problems.

enum: enable disable

default: enable

level: warning

default: disable

default: consistent

enum: whatever consistent

enum: unix dos platform

default: unix

enum: TRUE True true FALSE False false YES Yes yes NO No no ON On on OFF Off off


key: ignore

description: Ignore files, so that the linter doesn't process them.


key: locale

description: This is passed to Python's locale.setlocale.


key: braces

description: Use this rule to control the use of flow mappings or number of spaces inside braces ({ and }).


key: forbid

description: Used to forbid the use of flow mappings which are denoted by surrounding braces ({ and }).


key: min-spaces-inside

description: Defines the minimal number of spaces required inside braces.


key: max-spaces-inside

description: Defines the maximal number of spaces allowed inside braces.


key: min-spaces-inside-empty

description: Defines the minimal number of spaces required inside empty braces.


key: max-spaces-inside-empty

description: Defines the maximal number of spaces allowed inside empty braces.


key: brackets

description: Use this rule to control the use of flow sequences or the number of spaces inside brackets ([ and ]).


description: Used to forbid the use of flow sequences which are denoted by surrounding brackets ([ and ]).


description: Defines the minimal number of spaces required inside brackets.


description: Defines the maximal number of spaces allowed inside brackets.


description: Defines the minimal number of spaces required inside empty brackets.


description: Defines the maximal number of spaces allowed inside empty brackets.


key: colons

description: Use this rule to control the number of spaces before and after colons (:).


key: max-spaces-before

description: Defines the maximal number of spaces allowed before colons (use -1 to disable).


key: max-spaces-after

description: Defines the maximal number of spaces allowed after colons (use -1 to disable).


key: commas

description: Use this rule to control the number of spaces before and after commas (,).


description: Defines the maximal number of spaces allowed before commas (use -1 to disable).


key: min-spaces-after

description: Defines the minimal number of spaces required after commas.


description: Defines the maximal number of spaces allowed after commas (use -1 to disable).


key: comments

description: Use this rule to control the position and formatting of comments.


key: require-starting-space

description: Require a space character right after the #.


key: ignore-shebangs

description: Ignore a shebang at the beginning of the file when require-starting-space is set.


key: min-spaces-from-content

description: Used to visually separate inline comments from content.


key: comments-indentation

description: Use this rule to force comments to be indented like content.


key: document-end

description: Use this rule to require or forbid the use of document end marker (...).


key: present

description: True when the document end marker is required, or to false when it is forbidden.


key: document-start

description: Use this rule to require or forbid the use of document start marker (---).


description: True when the document start marker is required, or to false when it is forbidden.


key: empty-lines

description: Use this rule to set a maximal number of allowed consecutive blank lines.


key: max

description: Defines the maximal number of empty lines allowed in the document.


key: max-start

description: Defines the maximal number of empty lines allowed at the beginning of the file.


key: empty-values

description: Use this rule to prevent nodes with empty content, that implicitly result in null values.


key: forbid-in-block-mappings

description: Prevent empty values in block mappings.


key: forbid-in-flow-mappings

description: Prevent empty values in flow mappings.


key: hyphens

description: Use this rule to control the number of spaces after hyphens (-).


key: max-spaces-after

description: Defines the maximal number of spaces allowed after hyphens.


key: indentation

description: Use this rule to control the indentation.


key: spaces

description: Defines the indentation width, in spaces.


key: indent-sequences

description: Defines whether block sequences should be indented or not (when in a mapping, this indentation is not mandatory – some people perceive the - as part of the indentation).


key: check-multi-line-strings

description: Defines whether to lint indentation in multi-line strings.


key: key-duplicates

description: Use this rule to prevent multiple entries with the same key in mappings.


key: key-ordering

description: Use this rule to enforce alphabetical ordering of keys in mappings.


key: line-length

description: Use this rule to set a limit to lines length.


description: Defines the maximal (inclusive) length of lines.


key: allow-non-breakable-words

description: Used to allow non breakable words (without spaces inside) to overflow the limit.


key: allow-non-breakable-inline-mappings

description: Implies allow-non-breakable-words and extends it to also allow non-breakable words in inline mappings.


key: new-line-at-end-of-file

description:
Use this rule to require a new line character (
) at the end of files.


key: new-lines

description: Use this rule to force the type of new line characters.


key: type

description:
Unix to use UNIX-typed new line characters (
), or dos to use DOS-typed new line characters (
).


key: octal-values

description: Use this rule to prevent values with octal numbers.


key: forbid-implicit-octal

description: Prevent numbers starting with 0.


key: forbid-explicit-octal

description: Prevent numbers starting with 0o.


key: quoted-strings

description: Use this rule to forbid any string values that are not quoted, or to prevent quoted strings without needing it.

enum: single double any

default: any


key: quote-type

description: Defines allowed quotes.


key: required

description: Defines whether using quotes in string values is required.


key: extra-required

description: List of PCRE regexes to force string values to be quoted, if they match any regex.


key: extra-allowed

description: List of PCRE regexes to allow quoted string values, even if required: only-when-needed is set.


key: trailing-spaces

description: Use this rule to forbid trailing spaces at the end of lines.


key: truthy

description: Use this rule to forbid non-explictly typed truthy values other than allowed ones (by default: true and false), for example YES or off.

default: true false


key: allowed-values

description: Defines the list of truthy values which will be ignored during linting.


key: check-keys

description: Disables verification for keys in mappings.


key: children

description: The child permissions. Toggling the parent permission will toggle all child permissions too.


key: default

description: Indicates whether players have this permission by default.


key: description

description: Description of the permission


key: VersionConstraint

description: The name of the extension, or a mapping of the extension to the required version constraint.


key: api

description: The PocketMine API version(s) supported by the plugin. The array should be minimized such that no two API versions.


key: author

description: The author name


key: authors

description: The author names, will be appended to `author` if both are present


key: commands

description: The commands to be registered automatically. The keys are command name. Commands can also be dynamically registered with the server CommandMap.


key: aliases

description: Aliases of the command


description: Description of the command as shown in /help


key: permission

description: Name of the permission to check for, or multiple permissions separated


key: permission-message

description: Message to send to users if permission checks fail. Occurrences of <permission> are replaced with the `permission` property.


key: usage

description: Usage message of the command


key: depend

description: Plugin(s) in `depend` must be present and will be loaded BEFORE this plugin.


description: The detailed description of the plugin


key: extensions

description: Extension(s) required to load this plugin. Can be one extension name, a list of extension names or a mapping of extension name to version constraints.


key: load

description: The point of loading the plugin, defaults to POSTWORLD

enum: POSTWORLD STARTUP


key: loadbefore

description: Plugin(s) in `loadbefore` will be loaded AFTER this plugin if they are present.


key: main

description: The fully-qualified name of the main class that extends PluginBase


key: mcpe-protocols

description: The MCPE protocol versions supported by the plugin. If supported,


key: name

description: Name of the plugin


key: permissions

description: Permissions to be registered by this plugin automatically. Permissions can still be registered dynamically.


key: prefix

description: The plugin prefix used in the logger, defaults to plugin name


key: softdepend

description: Plugin(s) in `softdepend` will be loaded BEFORE this plugin if they are present, but nothing special happens if they are not present.


key: version

description: Plugin version


key: website

description: The plugin's website

format: iri


key: item

description: Items are the basic unit for a Postman collection. You can think of them as corresponding to a single API endpoint. Each Item has one request and may have multiple API responses associated with it.


key: auth-attribute

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


key: auth

description: Represents authentication helpers provided by Postman

enum: apikey awsv4 basic bearer digest edgegrid hawk noauth oauth1 oauth2 ntlm


key: apikey

description: The attributes for API Key Authentication.


description: The attributes for [AWS Auth](http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html).


key: basic

description: The attributes for [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication).


key: bearer

description: The helper attributes for [Bearer Token Authentication](https://tools.ietf.org/html/rfc6750)


key: digest

description: The attributes for [Digest Authentication](https://en.wikipedia.org/wiki/Digest_access_authentication).


key: edgegrid

description: The attributes for [Akamai EdgeGrid Authentication](https://developer.akamai.com/legacy/introduction/Client_Auth.html).


key: hawk

description: The attributes for [Hawk Authentication](https://github.com/hueniverse/hawk)


key: ntlm

description: The attributes for [NTLM Authentication](https://msdn.microsoft.com/en-us/library/cc237488.aspx)


description: The attributes for [OAuth2](https://oauth.net/1/)


description: Helper attributes for [OAuth2](https://oauth.net/2/)


key: certificate-list

description: A representation of a list of ssl certificates


key: certificate

description: A representation of an ssl certificate


key: name

description: A name for the certificate for user reference


key: matches

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


key: items

description: An Url match pattern string


key: key

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


key: src

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


key: cert

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


key: passphrase

description: The passphrase for the certificate


key: cookie-list

description: A representation of a list of cookies


key: cookie

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

required: domain path


key: domain

description: The domain for which this cookie is valid.


key: expires

description: When the cookie expires.


key: hostOnly

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


key: httpOnly

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


description: This is the name of the Cookie.


key: path

description: The path associated with the Cookie.


key: secure

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


key: session

description: True if the cookie is a session cookie.


key: value

description: The value of the Cookie.


key: extensions

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


key: description

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


key: content

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


key: type

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


key: version

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


key: event-list

description: Postman allows you to configure scripts to run when specific events occur. These scripts are stored here, and can be referenced in the collection by their ID.


key: event

description: Defines a script associated with an associated event name


key: id

description: A unique identifier for the enclosing event.


key: listen

description: Can be set to `test` or `prerequest` for test scripts or pre-request scripts respectively.


key: disabled

description: Indicates whether the event is disabled. If absent, the event is assumed to be enabled.


key: header-list

description: A representation for a list of headers


key: header

description: Represents a single HTTP Header

required: key value


key: key

description: This holds the LHS of the HTTP Header, e.g ``Content-Type`` or ``X-Custom-Header``


description: The value (or the RHS) of the Header is stored in this field.


description: If set to true, the current header will not be sent with requests.


key: info

description: Detailed description of the info block

required: name schema


key: name

description: A collection's friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this collection among a bunch of other collections, as such outlining its usage or content.


description:
Every collection is identified by the unique value of this field. The value of this field is usually easiest to generate using a UID generator function. If you already have a collection, it is recommended that you maintain the same id since changing the id usually implies that is a different collection than it was originally.
 *Note: This field exists for compatibility reasons with Collection Format V1.*


key: schema

description: This should ideally hold a link to the Postman schema that is used to validate this collection. E.g: https://schema.getpostman.com/collection/v1


key: item-group

description: One of the primary goals of Postman is to organize the development of APIs. To this end, it is necessary to be able to group requests together. This can be achived using 'Folders'. A folder just is an ordered set of requests.


description: A folder's friendly name is defined by this field. You would want to set this field to a value that would allow you to easily identify this folder.


key: item

description: Items are entities which contain an actual HTTP request, and sample responses attached to it. Folders may contain many items.


description: Items are entities which contain an actual HTTP request, and sample responses attached to it.


description: A unique ID that is used to identify collections internally


description: A human readable identifier for the current item.


key: protocol-profile-behavior

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


key: proxy-config

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


key: match

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


key: host

description: The proxy server host


key: port

description: The proxy server port


key: tunnel

description: The tunneling details for the proxy config


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


key: request

description: A request represents an HTTP request. If a string, the string is assumed to be the request URL and the method is assumed to be 'GET'.

enum: GET PUT POST PATCH DELETE COPY HEAD OPTIONS LINK UNLINK PURGE LOCK UNLOCK PROPFIND VIEW

enum: raw urlencoded formdata file graphql

type: array string null


key: method

description: The Standard HTTP method associated with this request.


description: The Custom HTTP method associated with this request.


key: body

description: This field contains the data usually contained in the request body.


key: mode

description: Postman stores the type of data associated with this request in this field.


key: disabled

description: When set to true, prevents this form data entity from being sent.


key: contentType

description: Override Content-Type header of this form data entity.


key: src

description: Contains the name of the file to upload. _Not the path_.


description: A null src indicates that no file has been selected as a part of the request body


key: options

description: Additional configurations and options set for various body modes.


description: When set to true, prevents request body from being sent.


key: response

description: A response represents an HTTP response.

type: null string number


key: id

description: A unique, user defined identifier that can  be used to refer to this response from requests.


key: responseTime

description: The time taken by the request to complete. If a number, the unit is milliseconds. If the response is manually created, this can be set to `null`.


key: timings

description: Set of timing information related to request and response in milliseconds


key: header

description: No HTTP request is complete without its headers, and the same is true for a Postman request. This field is an array containing all the headers.


description: The raw text of the response.


key: status

description: The response status, e.g: '200 OK'


key: code

description: The numerical response code, example: 200, 201, 404, etc.


key: script

description: A script is a snippet of Javascript code that can be used to to perform setup or teardown operations on a particular response.


description: A unique, user defined identifier that can  be used to refer to this script from requests.


key: type

description: Type of the script. E.g: 'text/javascript'


key: exec

description: This is an array of strings, where each line represents a single line of code. Having lines separate makes it possible to easily track changes made to scripts.


key: name

description: Script name


key: url

description: If object, contains the complete broken-down URL for this request. If string, contains the literal request URL.


key: raw

description: The string representation of the request URL, including the protocol, host, path, hash, query parameter(s) and path variable(s).


key: protocol

description: The protocol associated with the request, E.g: 'http'


key: host

description: The host for the URL, E.g: api.yourdomain.com. Can be stored as a string or as an array of strings.


description: The host, split into subdomain strings.


key: path

description: The complete path of the current url, broken down into segments. A segment could be a string, or a path variable.


key: port

description: The port number present in this URL. An empty value implies 80/443 depending on whether the protocol field contains http/https.


key: query

description: An array of QueryParams, which is basically the query string part of the URL, parsed into separate variables


key: disabled

description: If set to true, the current query parameter will not be sent with the request.


key: hash

description: Contains the URL fragment (if any). Usually this is not transmitted over the network, but it could be useful to store this in some cases.


key: variable

description: Postman supports path variables with the syntax `/path/:variableName/to/somewhere`. These variables are stored in this field.


key: variable-list

description:
Collection variables allow you to define a set of variables, that are a *part of the collection*, as opposed to environments, which are separate entities.
*Note: Collection variables must not contain any sensitive information.*


description: Using variables in your Postman requests eliminates the need to duplicate requests, which can save a lot of time. Variables can be defined, and referenced to from any part of a request.

enum: string boolean any number

required: id key