ci.json

markdownDescription: Gitlab has a built-in solution for doing CI called Gitlab CI. It is configured by supplying a file called `.gitlab-ci.yml`, which will list all the jobs that are going to run for the project. A full list of all options can be found [here](https://docs.gitlab.com/ee/ci/yaml). [Learn More](https://docs.gitlab.com/ee/ci/index.html).

format: uri

$ref: #/definitions/image

$ref: #/definitions/services

$ref: #/definitions/globalVariables

$ref: #/definitions/cache

$ref: #/definitions/!reference

$ref: #/definitions/artifacts

$ref: #/definitions/hooks

$ref: #/definitions/interruptible

$ref: #/definitions/retry

$ref: #/definitions/tags

$ref: #/definitions/timeout

markdownDescription: Groups jobs into stages. All jobs in one stage must complete before next stage is executed. Defaults to ['build', 'test', 'deploy']. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#stages).

default: build test deploy

markdownDescription: Can be `IncludeItem` or `IncludeItem[]`. Each `IncludeItem` will be a string, or an object with properties for the method if including external YAML file. The external content will be fetched, included and evaluated along the `.gitlab-ci.yml`. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#include).

$ref: #/definitions/job

markdownDescription: A special job used to upload static sites to Gitlab pages. Requires a `public/` directory with `artifacts.path` pointing to it. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#pages).

$ref: #/definitions/workflowName

$ref: #/definitions/if

$ref: #/definitions/changes

$ref: #/definitions/exists

$ref: #/definitions/rulesVariables

enum: always never

description: Hidden keys.

description: Arbitrary YAML anchor.

markdownDescription: Used to specify a list of files and directories that should be attached to the job if it succeeds. Artifacts are sent to Gitlab where they can be downloaded. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#artifacts).

markdownDescription: A list of paths to files/folders that should be included in the artifact. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#artifactspaths).

markdownDescription: A list of paths to files/folders that should be excluded in the artifact. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#artifactsexclude).

markdownDescription: Can be used to expose job artifacts in the merge request UI. GitLab will add a link <expose_as> to the relevant merge request that points to the artifact. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#artifactsexpose_as).

markdownDescription: Name for the archive created on job success. Can use variables in the name, e.g. '$CI_JOB_NAME' [Learn More](https://docs.gitlab.com/ee/ci/yaml/#artifactsname).

markdownDescription: Whether to add all untracked files (along with 'artifacts.paths') to the artifact. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#artifactsuntracked).

markdownDescription: Configure when artifacts are uploaded depended on job status. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#artifactswhen).

markdownDescription: How long artifacts should be kept. They are saved 30 days by default. Artifacts that have expired are removed periodically via cron job. 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'. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#artifactsexpire_in).

default: 30 days

markdownDescription: Reports will be uploaded as artifacts, and often displayed in the Gitlab UI, such as in Merge Requests. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#artifactsreports).

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.

description: Code coverage format used by the test framework.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

markdownDescription: Path to file or list of files with cyclonedx report(s). [Learn More](https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportscyclonedx).

markdownDescription: Path to file or list of files with load performance testing report(s). [Learn More](https://docs.gitlab.com/ee/ci/yaml/artifacts_reports.html#artifactsreportsload_performance).

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

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.

$ref: #/definitions/includeRules

$ref: #/definitions/inputs

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

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

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.

required: project file

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

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

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

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

markdownDescription: Specifies how to pull the image in Runner. It can be one of `always`, `never` or `if-not-present`. The default value is `always`. [Learn more](https://docs.gitlab.com/ee/ci/yaml/#imagepull_policy).

default: always

enum: always never if-not-present

markdownDescription: 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. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#image).

markdownDescription: Similar to `image` property, but will link the specified services to the `image` container. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#services).

markdownDescription: 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. [Learn More](https://docs.gitlab.com/ee/ci/services/index.html#available-settings-for-services)

markdownDescription: Specifies how to pull the image in Runner. It can be one of `always`, `never` or `if-not-present`. The default value is `always`. [Learn more](https://docs.gitlab.com/ee/ci/yaml/#servicepull_policy).

markdownDescription: Command or script that should be used as the container's command. It will be translated to arguments passed to Docker after the image's name. The syntax is similar to Dockerfile's CMD directive, where each shell token is a separate string in the array. [Learn More](https://docs.gitlab.com/ee/ci/services/index.html#available-settings-for-services)

markdownDescription: Additional alias that can be used to access the service from the job's container. Read Accessing the services for more information. [Learn More](https://docs.gitlab.com/ee/ci/services/index.html#available-settings-for-services)

markdownDescription: Additional environment variables that are passed exclusively to the service. Service variables cannot reference themselves. [Learn More](https://docs.gitlab.com/ee/ci/services/index.html#available-settings-for-services)

markdownDescription: Defines JWTs to be injected as environment variables.

markdownDescription: Defines secrets to be injected as environment variables. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#secrets).

markdownDescription: The secret to be fetched from Vault (e.g. 'production/db/password@ops' translates to secret 'ops/data/production/db', field `password`). [Learn More](https://docs.gitlab.com/ee/ci/yaml/#secretsvault)

markdownDescription: Configures the secret to be stored as either a file or variable type CI/CD variable. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#secretsfile)

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

markdownDescription: Defines scripts that should run *before* the job. Can be set globally or per job. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#before_script).

markdownDescription: Defines scripts that should run *after* the job. Can be set globally or per job. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#after_script).

markdownDescription: Rules allows for an array of individual rule objects to be evaluated in order, until one matches and dynamically provides attributes to the job. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#rules).

markdownDescription: You can use rules to conditionally include other configuration files. [Learn More](https://docs.gitlab.com/ee/ci/yaml/includes.html#use-rules-with-include).

markdownDescription: Use `when: never` to exclude the configuration file if the condition matches. [Learn More](https://docs.gitlab.com/ee/ci/yaml/includes.html#include-with-rulesif).

markdownDescription: Defines the pipeline name. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#workflowname).

markdownDescription: Defines default variables for all jobs. Job level property overrides global variables. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#variables).

markdownDescription: Default value of the variable. If used with `options`, `value` must be included in the array. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#variablesvalue)

markdownDescription: A list of predefined values that users can select from in the **Run pipeline** page when running a pipeline manually. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#variablesoptions)

markdownDescription: Explains what the variable is used for, what the acceptable values are. Variables with `description` are prefilled when running a pipeline manually. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#variablesdescription).

markdownDescription: If the variable is expandable or not. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#variablesexpand).

markdownDescription: Defines variables for a job. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#variables).

markdownDescription: Defines if the variable is expandable or not. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#variablesexpand).

markdownDescription: Defines variables for a rule result. [Learn More](https://docs.gitlab.com/ee/ci/yaml/index.html#rulesvariables).

markdownDescription: Expression to evaluate whether additional attributes should be provided to the job. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#rulesif).

markdownDescription: Additional attributes will be provided to job if any of the provided paths matches a modified file. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#ruleschanges).

description: List of file paths.

description: Ref for comparing changes.

markdownDescription: Additional attributes will be provided to job if any of the provided paths matches an existing file in the repository. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#rulesexists).

markdownDescription: Allows you to configure a timeout for a specific job (e.g. `1 minute`, `1h 30m 12s`). [Learn More](https://docs.gitlab.com/ee/ci/yaml/index.html#timeout).

markdownDescription: Used in conjunction with 'when: delayed' to set how long to delay before starting a job. e.g. '5', 5 seconds, 30 minutes, 1 week, etc. [Learn More](https://docs.gitlab.com/ee/ci/jobs/job_control.html#run-a-job-after-a-delay).

markdownDescription: Use needs in rules to update job needs for specific conditions. When a condition matches a rule, the job's needs configuration is completely replaced with the needs in the rule. [Learn More](https://docs.gitlab.com/ee/ci/yaml/index.html#rulesneeds).

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

description: Download artifacts of the job in needs.

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

markdownDescription: Allow job to fail. A failed job does not cause the pipeline to fail. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#allow_failure).

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.

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.

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

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)

markdownDescription: Describes the conditions for when to run the job. Defaults to 'on_success'. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#when).

enum: on_success on_failure always never manual delayed

markdownDescription: Use `cache` to specify a list of files and directories to cache between jobs. You can only use paths that are in the local working copy. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#cache)

markdownDescription: Use the `cache:key` keyword to give each cache a unique identifying key. All jobs that use the same cache key use the same cache, including in different pipelines. Must be used with `cache:path`, or nothing is cached. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#cachekey).

markdownDescription: Use the `cache:key:files` keyword to generate a new key when one or two specific files change. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#cachekeyfiles)

markdownDescription: Use `cache:key:prefix` to combine a prefix with the SHA computed for `cache:key:files`. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#cachekeyprefix)

markdownDescription: Use the `cache:paths` keyword to choose which files or directories to cache. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#cachepaths)

markdownDescription: Determines the strategy for downloading and updating the cache. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#cachepolicy)

markdownDescription: Use `unprotect: true` to set a cache to be shared between protected and unprotected branches.

markdownDescription: Use `untracked: true` to cache all files that are untracked in your Git repository. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#cacheuntracked)

markdownDescription: Defines when to save the cache, based on the status of the job. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#cachewhen).

markdownDescription: List of keys to download cache from if no cache hit occurred for key

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.

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

markdownDescription: Filter job by checking comparing values of CI/CD variables. [Learn More](https://docs.gitlab.com/ee/ci/jobs/job_control.html#cicd-variable-expressions).

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

markdownDescription: Retry a job if it fails. Can be a simple integer or object definition. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#retry).

markdownDescription: Either a single or array of error types to trigger job retry. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#retrywhen).

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

description: Retry when the failure reason is unknown.

description: Retry when the script failed.

description: Retry on API failure.

description: Retry when the job got stuck or timed out.

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

description: Retry if the runner is unsupported.

description: Retry if a delayed job could not be executed.

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

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

description: Retry if the job failed to complete prerequisite tasks.

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

description: Retry if there is a structural integrity problem detected.

markdownDescription: Interruptible is used to indicate that a job should be canceled if made redundant by a newer pipeline run. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#interruptible).

markdownDescription: Used to pass input values to included templates or components. [Learn More](https://docs.gitlab.com/ee/ci/yaml/includes.html#set-input-parameter-values-with-includeinputs).

markdownDescription: Shell scripts executed by the Runner. The only required property of jobs. Be careful with special characters (e.g. `:`, `{`, `}`, `&`) and use single or double quotes to avoid issues. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#script)

description: Define what stage the job will run in.

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

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

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

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

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.

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.

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

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.

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.

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.

enum: production staging testing development other

description: Indicates that the job creates a Release.

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.

description: Specifies the longer description of the Release.

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

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.

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.

description: Include asset links in the release.

description: The name of the link.

description: The URL to download a file.

description: The redirect link to the url.

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

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

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

markdownDescription: Trigger allows you to define downstream pipeline trigger. When a job created from trigger definition is started by GitLab, a downstream pipeline gets created. [Learn More](https://docs.gitlab.com/ee/ci/yaml/index.html#trigger).

markdownDescription: Trigger a multi-project pipeline. [Learn More](https://docs.gitlab.com/ee/ci/pipelines/multi_project_pipelines.html#specify-a-downstream-pipeline-branch).

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

description: The branch name that a downstream pipeline will use

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

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.

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

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.

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

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

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.

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

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

markdownDescription: Controls inheritance of globally-defined defaults and variables. Boolean values control inheritance of all default: or variables: keywords. To inherit only a subset of default: or variables: keywords, specify what you wish to inherit. Anything not listed is not inherited. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#inherit).

markdownDescription: Whether to inherit all globally-defined defaults or not. Or subset of inherited defaults. [Learn more](https://docs.gitlab.com/ee/ci/yaml/#inheritdefault).

enum: after_script artifacts before_script cache image interruptible retry services tags timeout

markdownDescription: Whether to inherit all globally-defined variables or not. Or subset of inherited variables. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#inheritvariables).

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

markdownDescription: Used to select runners from the list of available runners. A runner must have all tags listed here to run the job. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#tags).

markdownDescription: Specifies lists of commands to execute on the runner at certain stages of job execution. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#hooks).

markdownDescription: Specifies a list of commands to execute on the runner before updating the Git repository and any submodules. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#hookspre_get_sources_script).


mocharc.json

type: boolean

type: integer

type: string

type: array

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

$ref: #/definitions/bool

$ref: #/definitions/string-array

$ref: #/definitions/int

$ref: #/definitions/string

title: Mocha JS Configuration File Schema

type: object


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.

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.

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

title: Embrace Config Schema


github-action.json

$comment: escape `{` and `}` in pattern to be unicode compatible (#1360)

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.

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

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

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

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

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

$ref: #/definitions/pre-if

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

$ref: #/definitions/post-if

required: using main

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

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

const: composite

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

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

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

enum: bash pwsh python sh cmd powershell

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

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.

description: The name of the composite run step.

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

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.

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

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

$ref: #/definitions/expressionSyntax

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

required: run shell

required: using steps

description: Configures the image used for the Docker action.

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

const: docker

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.

type: number

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.

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

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

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.

required: using image

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 `_`.

description: A string description of the output parameter.

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.

required: description value

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

description: The name of the action's author.

description: A short description of the action.

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.

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

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

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

$comment: Because of `additionalProperties: false`, this empty schema is needed to allow the `outputs` property. The `outputs` subschema is determined by the if/then/else keywords.

$ref: #/definitions/runs-javascript

$ref: #/definitions/runs-composite

$ref: #/definitions/runs-docker

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.

description: The background color of the badge.

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

description: The name of the Feather icon to use.

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

required: name description runs


jsonConfig.json

description: Control type

enum: tabs panel

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

$ref: #/definitions/multilingual

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

description: Object representing e.g. a tab

const: language

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

required: type system

const: autocompleteSendTo

description: Command to be sent.

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

description: Data to be sent as JSON.

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

description: Placeholder (for text control)

required: type command

const: selectSendTo

description: Command to be sent.

description: Data to be sent as JSON.

description: Allow manual editing. Without Dropdown

const: textSendTo

description: div, text

description: If true, show button

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

description: Command to be sent.

description: Data to be sent as JSON.

const: header

description: Size of the header: h1-h5

description: Header text

required: type size text

const: color

const: divider

description: Optional color

enum: primary secondary

description: Optional height

const: icon

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

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

description: Maximum width

description: Maximum height

description: Maximum size

const: panel

$ref: #/properties/items

description: Panel can have icon (base64)

required: type items

const: image

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

description: 'Maximum width

description: 'Maximum height

description: 'Maximum size

description: Name of the file

const: sendTo

description: Command to be sent.

description: Optional color

description: sendTo can have icon (base64)

description: Data to be sent as JSON.

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

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

description: If outlined or contained

enum: contained outlined

description: Placeholder (for text control)

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

description: Show spinner while request is in progress

const: password

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

description: Password must be compared with password

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

const: file

description: Name of the file

required: type filename

const: slider

description: Minimal value

description: Maximum number

description: Step size

const: custom

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

const: checkbox

const: number

description: Placeholder (for text control)

description: Minimal value

description: Maximum number

const: autocomplete

description: Placeholder (for text control)

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

description: Text input

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

description: Placeholder (for text control)

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

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

description: Options which can be selected

description: Label

description: Value

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

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

description: Items of the table

description: Command to be sent.

description: Data to be sent as JSON.

description: Placeholder (for text control)

description: Command to be sent.

description: Data to be sent as JSON.

description: Allow manual editing. Without Dropdown

description: div, text

description: If true, show button

description: Command to be sent.

description: Data to be sent as JSON.

description: Size of the header: h1-h5

description: Header text

description: Optional color

description: Optional height

description: Maximum width

description: Maximum height

description: Maximum size

description: Panel can have icon (base64)

description: 'Maximum width

description: 'Maximum height

description: 'Maximum size

description: Name of the file

description: Command to be sent.

description: Optional color

description: sendTo can have icon (base64)

description: Data to be sent as JSON.

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

description: If outlined or contained

description: Placeholder (for text control)

description: Password must be compared with password

description: Name of the file

description: Minimal value

description: Maximum number

description: Step size

description: Placeholder (for text control)

description: Minimal value

description: Maximum number

description: Placeholder (for text control)

description: Text input

description: Placeholder (for text control)

description: Options which can be selected

description: Label

description: Value

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

description: If true, show copy button.

description: Optional color

description: setState can have icon (base64)

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

description: ack-flag of the state

description: State value to set

description: Alert that will be shown by pressing the button

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

description: If outlined or contained

description: no system.func.

description: no system.room.

description: no system.user.

description: Add 0.0.0.0 to option

description: Show only IP4 addresses

description: Show only IP6 addresses

description: Type of the certificate

description: Link

description: Static link or button

description: icon for button

description: Static text like description

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

description: Add to the options ALL option with value *

description: Name of picture (from admin directory)

description: Link

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

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

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

description: Placeholder (for text control)

description: If UUID must be checked too

description: Check version

description: Label of tab

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

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

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

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

description: Should be shown from new line

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

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

description: href to help

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

description: css style for dark mode

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

description: True if save must be disabled by errors

description: Text to show if validator fails

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

description: Optional tooltip

description: Default value

description: JS function: that calculates value

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

description: JS function to calculate default value

description: JS function: that calculates value

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

description: Confirm dialog

description: JS function: true show confirm dialog

description: Text of confirmation dialog

description: Title of confirmation dialog

description: Text for 'OK' button

description: Text for 'cancel' button

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

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

description: max length of text in field

description: show link as button

description: If true, show copy button.

description: Optional color

description: setState can have icon (base64)

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

description: ack-flag of the state

description: State value to set

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

description: If outlined or contained

description: no system.func.

description: no system.room.

description: no system.user.

description: Add 0.0.0.0 to option

description: Show only IP4 addresses

description: Show only IP6 addresses

description: Type of the certificate

description: Link

description: Static link or button

description: icon for button

description: Static text like description

description: Name of picture (from admin directory)

description: Link

description: Placeholder (for text control)

description: If UUID must be checked too

description: Check version

description: Label of tab

description: Type of the element

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: Width in 1/12 of screen on small screen

description: Should be shown from new line

description: href to help

description: css style for dark mode

description: True if save must be disabled by errors

description: Text to show if validator fails

description: Optional tooltip

description: Default value

description: JS function: that calculates value

description: JS function to calculate default value

description: JS function: that calculates value

description: Confirm dialog

description: JS function: true show confirm dialog

description: Text of confirmation dialog

description: Title of confirmation dialog

description: Text for 'OK' button

description: Text for 'cancel' button

description: max length of text in field

description: show link as button


dockerd.json

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

title: Docker Daemon configuration schema


templatesources.json

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

description: The name of the source.

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

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

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

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

title: JSON schema for SideWaffle template sources


local.settings.json

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.

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.

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.

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.

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.

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.

description: When set to true, allows withCredentials requests.

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.

title: JSON schema for Azure Functions local.settings.json files


title: dbt_project

default: true

title: Docs config

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.

title: Label configs

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

title: Metric configs

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

title: Model configs

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

$ref: #/$defs/alias

$ref: #/$defs/contract

$ref: #/$defs/database

$ref: #/$defs/location

$ref: #/$defs/materialized

$ref: #/$defs/schema

title: Persist docs config

description: Configurations for the persistence of the dbt documentation.

title: Seed configs

title: Snapshot configs

$ref: #/$defs/grants

$ref: #/$defs/strategy

title: Source configs

title: Test configs

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

$ref: #/$defs/limit

$ref: #/$defs/severity

title: Authorized views

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.

enum: warn error


ansible-navigator.json

description: Extra parameters passed to the corresponding command

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

description: Specify the path to the ansible configuration file

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

description: Specify the plugin name

default: module

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

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

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

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

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

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

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

description: Write ansible-runner job_events in the artifact directory

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

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

default: welcome

description: Subcommands

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

description: The path to collection doc cache

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

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

default: vi +{line_number} {filename}

description: Specify the editor command

description: Specify if the editor is console based

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

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

default: auto

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

enum: auto podman docker

description: Extra parameters passed to the container engine command

description: Enable or disable the use of an execution environment

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

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

description: Specify the name of the execution environment image

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'

default: tag

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

enum: always missing never tag

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

required: src dest

default: yaml

description: Specify the format for stdout output.

enum: json yaml

description: Provide detailed information about the selected execution environment image

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

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

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

default: warning

description: Specify the ansible-navigator log level

enum: debug info warning error critical

default: interactive

description: Specify the user-interface mode

enum: stdout interactive

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

description: Specify the path for the playbook artifact to replay

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

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

description: Generate a sample settings file

default: json

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

description: Show the source of each current settings entry

default: UTC

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

title: ansible-navigator settings v3


aliases.json

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

title: alias

title: command

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

title: confirm

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

title: confirmation message

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

title: conditional

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

title: backout seconds

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

title: conditional

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

title: quiet

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

title: alias


title: instructions

$ref: #/definitions/BlueprintInputObject

title: Inputs

title: Outputs

$ref: #/definitions/GrainObject

title: Grains

title: Torque Blueprint Spec 2

enum: terraform helm ansible blueprint arm cloudformation kubernetes shell cloudshell

$ref: #/definitions/GrainSpecObject

required: kind spec

title: Grain Object

$ref: #/definitions/ScriptObject

$ref: #/definitions/ScriptOutputsObject

$ref: #/definitions/ScriptSource

type: string number boolean

title: Envrironment Variable

$ref: #/definitions/GrainSpecSources

$ref: #/definitions/GrainSpecSourceObject

$ref: #/definitions/GrainSpecHostObject

$ref: #/definitions/GrainInput

$ref: #/definitions/GrainCommand

$ref: #/definitions/GrainScripts

$ref: #/definitions/GrainTag

$ref: #/definitions/EnvironementVariable

$ref: #/definitions/Backend

$ref: #/definitions/ActivitiesObject

$ref: #/definitions/TfVarsFileSourceObject

title: Grain Spec Object

$ref: #/definitions/ActivityObject

$ref: #/definitions/CommandObject

title: Grain Input

title: Grain Output

title: Grain Command

title: Spec Host Properties

title: PurpleSource

title: TfVarsFileSource

title: Blueprint Input Object

enum: string execution-host agent

enum: multiline normal masked

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

title: Blueptint Output Object

title: InstructionsSource


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

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

enum: ssm secrets-manager

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

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

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

default: /<stage>/<service>/

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

required: type path

enum: json yaml dotenv types-node

description: Type of file to generate

description: Full path with filename for writing the output

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

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.

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

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>

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.

required: service provider


npm-badges.json

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

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

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

description: Configuration object

description: The npm package name

description: The username of the SauceLabs account

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

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

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

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

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

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

description: The branch to constrain the badge to.

description: The event to constrain the badge to.

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

See https://nodei.co for details

description: The 60devs username to donate to.

description: The URL to the 60devs donate page.

description: The Patreon username to donate to.

description: The URL to the Patreon donate page.

description: The Open Collective username to donate to.

description: The URL to the Open Collective donate page.

description: The home page URL

description: The twitter username to tweet at

description: The Github username to use

title: Configuration for the NPM package badges.


yamllint.json

$ref: #/definitions/ignore

enum: enable disable

title: Ignore

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

title: Level

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

title: Extends

title: YAML Files

title: YAML File

title: Locale

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

title: Braces

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

$ref: #/definitions/toggle

$ref: #/definitions/allRules

title: Forbid

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

title: Minimum Spaces Inside

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

title: Max Spaces Inside

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

title: Minimum Spaces Inside Empty

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

title: Max Spaces Inside Empty

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

default: enable

title: Brackets

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

title: Forbid

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

title: Minimum Spaces Inside

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

title: Max Spaces Inside

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

title: Minimum Spaces Inside Empty

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

title: Max Spaces Inside Empty

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

title: Colons

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

title: Max Spaces Before

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

title: Max Spaces After

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

title: Commas

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

title: Max Spaces Before

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

title: Minimum Spaces After

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

title: Max Spaces After

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

title: Comments

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

title: Require Starting Space

description: Require a space character right after the #.

title: Ignore Shebangs

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

title: Minimum Spaces from Content

description: Used to visually separate inline comments from content.

level: warning

title: Comments Indentation

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

title: Document End

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

title: Present

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

default: disable

title: Document Start

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

title: Present

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

title: Empty Lines

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

title: Max

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

title: Max Start

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

title: Max End

title: Empty Values

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

title: Forbid in Block Mappings

description: Prevent empty values in block mappings.

title: Forbid in Flow Mappings

description: Prevent empty values in flow mappings.

title: Hyphens

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

title: Max Spaces After

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

title: Indentation

description: Use this rule to control the indentation.

title: Spaces

description: Defines the indentation width, in spaces.

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

title: Check Multi Line Strings

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

title: Key Duplicates

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

title: Key Ordering

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

title: Line Length

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

title: Max

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

title: Allow Non-Breakable Words

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

title: Allow Non-Breakable Inline Mappings

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

title: New Line at End of File

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

title: New Lines

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

title: Type

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

title: Octal Values

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

title: Forbid Implicit Octal

description: Prevent numbers starting with 0.

title: Forbid Explicit Octal

description: Prevent numbers starting with 0o.

title: Quoted Strings

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

title: Quote Type

description: Defines allowed quotes.

title: Required

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

title: Extra Required

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

title: Pattern

title: Extra Allowed

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

title: Pattern

title: Tailing Spaces

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

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

title: Allowed Values

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

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

title: Check Keys

description: Disables verification for keys in mappings.

title: yamllint


pocketmine-plugin.json

$ref: #/definitions/PermissionChildren

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

description: Indicates whether players have this permission by default.

description: Description of the permission

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

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

description: The author name

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

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

description: Aliases of the command

description: Description of the command as shown in /help

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

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

description: Usage message of the command

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

description: The detailed description of the plugin

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.

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

enum: POSTWORLD STARTUP

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

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

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

description: Name of the plugin

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

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

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

description: Plugin version

description: The plugin's website

format: iri

required: api main name version


collection.json

$ref: #/definitions/info

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.

title: Items

$ref: #/definitions/item

$ref: #/definitions/item-group

$ref: #/definitions/event-list

$ref: #/definitions/variable-list

$ref: #/definitions/auth

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

required: info item

title: Auth

$id: #/definitions/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.

title: Auth

$id: #/definitions/auth

description: Represents authentication helpers provided by Postman

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

title: API Key Authentication

description: The attributes for API Key Authentication.

$ref: #/definitions/auth-attribute

title: AWS Signature v4

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

title: Basic Authentication

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

title: Bearer Token Authentication

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

title: Digest Authentication

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

title: EdgeGrid Authentication

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

title: Hawk Authentication

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

title: NTLM Authentication

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

title: OAuth1

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

title: OAuth2

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

$id: #/definitions/certificate-list

title: Certificate List

description: A representation of a list of ssl certificates

$ref: #/definitions/certificate

$id: #/definitions/certificate

title: Certificate

description: A representation of an ssl certificate

description: A name for the certificate for user reference

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

description: An Url match pattern string

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

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

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

description: The passphrase for the certificate

$id: #/definitions/cookie-list

title: Certificate List

description: A representation of a list of cookies

$ref: #/definitions/cookie

title: Cookie

$id: #/definitions/cookie

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

description: The domain for which this cookie is valid.

description: When the cookie expires.

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

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

description: The path associated with the Cookie.

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

description: True if the cookie is a session cookie.

description: The value of the Cookie.

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

required: domain path

$id: #/definitions/description

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

title: Description

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

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.

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

$id: #/definitions/event-list

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

$ref: #/definitions/event

$id: #/definitions/event

title: Event

description: Defines a script associated with an associated event name

description: A unique identifier for the enclosing event.

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

$ref: #/definitions/script

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

$id: #/definitions/header-list

title: Header List

description: A representation for a list of headers

$ref: #/definitions/header

title: Header

$id: #/definitions/header

description: Represents a single HTTP Header

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.

$ref: #/definitions/description

required: key value

$id: #/definitions/info

title: Information

description: Detailed description of the info block

title: Name of the collection

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

$ref: #/definitions/version

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

required: name schema

title: Folder

$id: #/definitions/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.

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

title: Items

title: Item

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

description: A human readable identifier for the current item.

title: Responses

title: Protocol Profile Behavior

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

title: Proxy Config

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

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

description: The proxy server host

description: The proxy server port

description: The tunneling details for the proxy config

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

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

title: Request

description: The Standard HTTP method associated with this request.

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

description: The Custom HTTP method associated with this request.

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

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

title: UrlEncodedParameter

title: FormParameter

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

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

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

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

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

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

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

title: Response

description: A response represents an HTTP response.

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

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

title: Response Timings

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

title: Headers

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

title: Header

description: The raw text of the response.

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

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

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

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

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.

description: Script name

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

title: Url

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

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

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

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

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

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

title: QueryParam

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

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.

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

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

title: Variable

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.

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

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

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

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

description: Variable name

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

title: Collection Version

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

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

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

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

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


block-metadata.json

required: type url

$ref: #/definitions/JsonValue

$ref: #/definitions/JsonObject

description: The name of the author of the block

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

enum: custom-element html react

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

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

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

description: The display name used for a block

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

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

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

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

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

description: A unique, slugified name for the block.

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

$ref: #/definitions/BlockMetadataRepository

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

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

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

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

required: name properties

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

required: blockType name protocol schema source version


taurus.json

enum: ab apiritif gatling grinder jmeter junit locust mocha molotov newman nunit pbench pytest rspec selenium siege tsung wdio

enum: final-stats console blazemeter junit-xml