micro-syntax.json

$comment: Port this schema to https://github.com/zyedidia/micro repository.

title: rule

description:
A region start
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

description:
A region end
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

description:
Ignored region sequences
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

$ref: #/definitions/rules

description:
Rules
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

description:
A rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: comment rule region

description:
A comment rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

$ref: #/definitions/string-or-region

title: line comment rule region

description:
A line comment rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: block comment rule region

description:
A block comment rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: identifier rule region

description:
An identifier rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: builtin identifier rule region

description:
A builtin identifier rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: type identifier rule region

description:
A type rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: builtin type identifier rule region

description:
A builtin type rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: callable identifier rule region

description:
A callable identifier rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: builtin callable identifier rule region

description:
A builtin callable identifier rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: macro identifier rule region

description:
A macro rule
Also used for functions
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: builtin macro identifier rule region

description:
A builtin macro rule
Also used for functions
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: variable identifier rule region

description:
A variable identifier rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: builtin variable identifier rule region

description:
A builtin variable identifier rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: constant rule region

description:
A constant rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: null identifier rule region

description:
A null rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: bool constant rule region

description:
A bool constant rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: true bool constant rule region

description:
A true bool constant rule
`.builtin` suffix is not used
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: false bool constant rule region

description:
A false bool constant rule
`.builtin` suffix is not used
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: number constant rule region

description:
A number constant rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: integer number constant rule region

description:
A integer number constant rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: float number constant rule region

description:
A float number constant rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: complex number constant rule region

description:
A complex number constant rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: string constant rule region

description:
A string constant rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: builtin string constant rule region

description:
A builtin string constant rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: url string constant rule region

description:
A url string constant rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: escape string constant rule region

description:
A escape string constant rule
`.builtin` suffix is not used
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: string format specifier constant rule region

description:
A string format specifier constant rule
`.builtin` suffix is not used
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: statement rule region

description:
A statement rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: symbol rule region

description:
A symbol rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: bracket symbol rule region

description:
A bracket symbol rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: operator symbol rule region

description:
An operator symbol rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: tag symbol rule region

description:
A tag symbol rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: preprocessor rule region

description:
A preprocessor rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: shebang preprocessor rule region

description:
A shebang preprocessor rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: type rule region

title: builtin type rule region

title: keyword type rule region

description:
A keyword type rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: todo region

description:
A todo rule
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

description:
An include
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-rules

title: rule region

description:
A syntax
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#syntax-files

description:
A file type
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#filetype-definition

title: detection options

description:
Detection options
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#detect-definition

description:
A file name
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#detect-definition

description:
A file header
https://github.com/zyedidia/micro/blob/master/runtime/help/colors.md#detect-definition

title: rule

title: syntax


resourceoverrides.json

description: Super-schema that describes all versions of 'CICS resource overrides JSON Schema for CICS TS 6.1.0.'

title: CICS resource overrides JSON Schema.

description: Schema that describes the structure of a CICS resource overrides document.


chrome-extension-locales-messages.json

description:
The translated message, in the form of a string that can contain placeholders. Use `$_placeholder_name_$` (case insensitive) to refer to a particular placeholder. For example, you can refer to a placeholder named "our_site" as `$our_site$`, `$OUR_SITE$`, or `$oUR_sITe$`.
To put a dollar sign (`$`) into the string, use `$$`.
Although placeholders such as `$USER$` are the preferred way of referring to substitution strings (strings specified using the substitutions parameter of i18n.getMessage) you can also refer to substitution strings directly within the message.

examples: Goodbye, $USER$. Come back to $OUR_SITE$ soon!

type: string

title: message

description: Optional. A description of the message, intended to give context or details to help the translator make the best possible translation.

examples:
Ask for the user's name
Greet the user
Say goodbye to the user

title: description

description:
Optional. Defines one or more substrings to be used within the message.
Each placeholder has a name, a "content" item, and an optional "example" item. A placeholder's name is case-insensitive and can contain the same characters as a message name.

description: The "content" item's value is a string that can refer to substitution strings, which are specified using the i18n.getMessage method's substitutions parameter. The value of a "content" item is typically something like "Example.com" or "$1". If you refer to a substitution string that doesn't exist, you get an empty string. The following table shows how `$_n_` strings correspond to strings specified by the substitutions parameter.

title: content

description: The "example" item (optional, but highly recommended) helps translators by showing how the content appears to the end user. For example, a placeholder for a dollar amount should have an example like `"$23.45"`.

title: example

type: object

title: placeholders


task.json

$ref: #/$defs/baseDefinitionWithoutSlug

description: Set to false to disallow requesters from approving their own requests for this task.

type: boolean

description: If non-empty, restricts runs with the same concurrency key from executing at the same time.

description: If concurrency key is set, only allows this task's runs to start if the number of other active runs with the same key is below this limit.

type: number

$ref: #/$defs/configs

description: Set label constraints to restrict this task to run only on agents with matching labels.

default: task-viewers

description: Manage who can view new runs of this task. If not specified, defaults to 'task-viewers'

enum: task-viewers task-participants

description: A human-readable description for your task.

description: A human-readable name for your task.

description: A list of inputs to your task.

$ref: #/$defs/parameter

type: array

description: Permissions for the task. If specified, permission configuration will not be allowed in the UI.

$ref: #/$defs/permissionConfig

description: Groups and users who have full access to the task, and can change task configurations and permissions.

description: Groups and users who have all the permissions of requesters, and can also execute tasks and other's requests.

description: Groups and users who have all the permission of viewers, and can also request tasks.

description: Groups and users who can see task information, but can't request or execute tasks.

description: Set to true to disable direct execution of this task.

description: A list of resources to make available to your task. Resources are identified by slug, but can be mapped to an alias to configure how the task references the resource. If using aliases, resources are expressed as a map of alias to slug.

description: Hide this task in the UI and disable direct execution. This task may only be executed by the specified callers.

examples: task view

enum: task view

description: Set the runtime used for this task.

description: A map of schedules that are to be deployed with this task. The key corresponds to a unique schedule across deploys.

Daily Midnight Batch

description: Runs this task daily at midnight.

param_two: hello

description: The cron string in crontab format

description: The description of the schedule

description: The name of the schedule

description: A map of parameter slugs to values to be passed to the task each run

description: The maximum number of seconds the task should take before being timed out.

description: A list of webhooks that are to be deployed with this task.

description: A map of environment variables to use when running the task. If specifying raw values, the value may be a string; if using config variables, the value must be an object with config mapped to the name of the config variable.

description: A map from environment slug to override for that environment.

description: The default value of the parameter.

description: A human-readable description of the parameter.

description: A JST that's evaluated to determine whether the parameter is hidden. You can reference the value of other parameters using the `params` object.

description: Whether the parameter is a list parameter or not.

description: A human-readable name for the parameter.

description: A list of options to constrain the parameter values. For configvar types, each option needs to be an object with a label (value to show to user) and a config (name of the config var). For all other types, each option can be a single value or an object with a label and a value.

label: Batman

value: Bruce Wayne

required: label value

required: label config

description: The task that's run to populate the options.

description: A JST that's evaluated to determine whether to run the task to populate the options. You can reference the value of other parameters using the `params` object.

description: A regular expression with which to validate parameter values.

format: regex

description: Set to false to indicate that this parameter is optional.

description: An identifier for the parameter, which can be used in JavaScript templates (https://docs.airplane.dev/runbooks/javascript-templates).

description: The type of parameter.

enum: shorttext longtext sql boolean upload integer float date datetime configvar json

description: A JST that's evaluated to validate the parameter value. This should evaluate to a string error message if the validation fails. You can reference the value of other parameters using the `params` object.

examples: params.country.value === 'USA' ? 'The country cannot be set to USA.' : undefined

required: slug type

description: Groups to assign the permission to.

description: Users to assign the permission to.

description: Configuration for a Node task.

description: The type of base image to use; if not specified, defaults to full.

description: The path to the .ts or .js file containing the logic for this task. This can be absolute or relative to the location of the definition file.

description: The version of Node to use.

description: Configuration for a Python task.

description: The path to the .py file containing the logic for this task. This can be absolute or relative to the location of the definition file.

description: Configuration for a shell task.

description: The path to the .sh file containing the logic for this task. This can be absolute or relative to the location of the definition file.

description: Configuration for a Docker task.

description: The Docker command to run. Supports JavaScript templates (https://docs.airplane.dev/runbooks/javascript-templates).

examples:
echo "hello world"
echo "{{params.input}}"

description: Specify a Docker entrypoint to override the default image entrypoint.

description: The name of the image to use.

description: Configuration for a SQL task.

description: (Deprecated) A list of config variables that this task can access. Use top-level `configs` instead.

description: The path to the .sql file containing the logic for this task. This can be absolute or relative to the location of the definition file. The contents of the .sql file support JavaScript templates (https://docs.airplane.dev/runbooks/javascript-templates).

description: A map of query arguments that can be used to safely pass parameter inputs to your query. Supports JavaScript templates (https://docs.airplane.dev/runbooks/javascript-templates).

description: The slug of a database resource. (Deprecated: This can also be the name of the resource.)

description: The transaction mode to use.

description: Configuration for a REST task.

description: The body of the request. Supports JavaScript templates (https://docs.airplane.dev/runbooks/javascript-templates).

description: The type of body that this request should send.

enum: json raw form-data x-www-form-urlencoded

description: A map of form values. Supports JavaScript templates (https://docs.airplane.dev/runbooks/javascript-templates).

description: A map of request headers. Supports JavaScript templates (https://docs.airplane.dev/runbooks/javascript-templates).

description: The HTTP method to use.

description: The path to request. Your REST resource may specify a path prefix as part of its base URL, in which case this path is joined to it. Airplane recommends that this start with a leading slash. Supports JavaScript templates (https://docs.airplane.dev/runbooks/javascript-templates).

description: The slug of a REST resource. (Deprecated: This can also be the name of the resource.)

description: Retry the request if the server returns a 500, 502, 503, or 504 status code. Requests are always retried on 408 and 429 status codes. Supports JavaScript templates (https://docs.airplane.dev/runbooks/javascript-templates).

description: A map of URL parameters. Supports JavaScript templates (https://docs.airplane.dev/runbooks/javascript-templates).

description: Configuration for a GraphQL task.

description: The query or mutation to execute.

description: The slug of a GraphQL resource.

description: A map of GraphQL variables. Supports JavaScript templates (https://docs.airplane.dev/runbooks/javascript-templates).

title: Task


trunk-yaml-schema.json

description:
List of filetypes
To refer to all filetypes, use [ALL]

examples: ALL bazel-build bazel-workspace c c# c++ c++-header c++-source c-header c-source c/c++ c/c++-source css cue docker dotenv gemspec go graphql haml html java javascript json kotlin latex markdown php prettier_supported_configs proto python ruby rust sass scala shell sql starlark svg terraform toml typescript yaml zsh

description:
List of linter IDs
To refer to all linters, use [ALL]

examples: ALL actionlint ansible-lint autopep8 bandit black black-py brakeman buf-breaking buf-format buf-lint buildifier cfnlint clang-format clang-tidy clippy cue-fmt detekt detekt-explicit detekt-gradle dotenv-linter eslint flake8 git-diff-check gitleaks gofmt goimports golangci-lint hadolint haml-lint include-what-you-use isort ktlint markdownlint mypy prettier pylint rubocop rubocop-fmt rufo rustfmt scalafmt semgrep shellcheck shfmt sql-formatter standardrb stylelint stylelint-fmt svgo taplo taplo-fmt terraform terraform-fmt terraform-validate tflint yamllint yapf

description: String where "${key1} ${key2}" will be expanded into "value1 value2"

description: The last linter you'll ever need

type: string number boolean

examples: go java node python ruby rust

examples: critical debug error info off trace warn

type: integer

examples: linux macos

description: Whether or not this will be run on empty files

description:
Whether linter invocations for multiple targets should be batched; used to cut down on per-invocation overhead

Causes every token containing ${target} to be expanded multiple times, e.g. 'my_linter target=${target}' would be expanded into 'my_linter target=target1 target=target2 ... target=targetN'

description: Whether Trunk can cache results for this linter

description: argv of the command to invoke the linter with

description: Whether or not we support linting the upstream version of a target

description: Whether the command is enabled to run when the linter is run. Allows some commands of a linter to be run by default without others.

description: Exit codes implying the linter experienced an internal error

description: Whether or not this linter will be run by 'trunk fmt'; default: false

description: Whether the linter modifies ${target} files in-place.

description: Output type of this linter; controls how `trunk` parses its output

examples: actionlint ansible_lint arcanist bandit brakeman buf buildifier cfnlint clippy detekt_gradle diff eslint gitleaks golangci_lint hadolint haml_lint iwyu llvm lsp_json markdownlint mypy pass_fail pylint regex rewrite rubocop sarif semgrep shellcheck shfmt stylelint taplo terraform_validate

description: Command to initialize the linter with

description:
Tell parser where to expect output from for reading (if 'tmpfile', then the linter should write its output to ${tmpfile})

NOTE: this field is only respected for type=sarif linters currently

description: Command to invoke the linter with (write as if you were typing into your shell)

examples: "${linter}" will expand to the directory a linter is installed into, e.g. "${linter}/node_modules/.bin" is appended to the `PATH` of any linter with `runtime: node`

examples: "${runtime}" will expand to the directory a runtime is installed into, e.g. with `runtime: node`, "${runtime}/bin/npm" will yield the path to the installed NPM binary

description: The nearest target to search for when 'run_linter_from' is 'root_file' or 'root_directory'

description:
What to use as the current working directory:
  * workspace - the root of the repository
  * parent_directory - the directory containing the linter target
  * directory - the linter target itself, with the condition that the linter target is a directory itself
  * root_file - the nearest directory containing 'run_from_root_target', e.g. the nearest directory containing a go.mod file
  * root_directory - the nearest directory matching 'run_from_root_target', e.g. the nearest src/ directory

description: Whether or not this linter takes its input from stdin

description: Exit codes corresponding to no issues found or issues found

description: The download containing this linter (i.e. the `name` of an entry in `downloads`)

description: Environment variables set when `trunk` runs the linter

description: The envvar will be set to the `:`-joined list

description: Extra packages needed to run this linter; also installed using the runtime's package manager

description: Filetypes to run this linter on

description: Whether or not this linter can handle LFS files; default: false

description: Linter ID; use this in fields like `enabled` to reference this linter

description: The package containing this linter; installed using the runtime's package manager

description: argv of the command to initialize the linter with

description: The runtime, toolchain, and package manager used to run and install a linter

description: linter@envOrVersion, where envOrVersion is either the name of an environment, the version of the main `package` if `runtime` is set, or the verson of the `download`

examples: flake8@4.0.1 { packages [ 'flake8-bugbear@21.9.2', 'flake8-docstring@1.6.0' ] }

description: Paths to exclude from linting

examples: actionlint ansible_lint arcanist bandit brakeman buf buildifier cfnlint clippy detekt_gradle diff eslint gitleaks golangci_lint hadolint haml_lint iwyu llvm lsp_json markdownlint mypy pass_fail pylint regex rewrite rubocop sarif semgrep shellcheck shfmt stylelint taplo terraform_validate

description: See https://docs.trunk.io

description: The trunk config version being parsed. The only possible value is 0.1.

title: Configuration schema for trunk, a powerful linter runner - https://docs.trunk.io


cloudbuild.json

description: A step in the build pipeline.

description:
Required. The name of the container image that will run this particular
build step.

If the image is available in the host's Docker daemon's cache, it
will be run directly. If not, the host will attempt to pull the image
first, using the builder service account's credentials if necessary.

The Docker daemon's cache will already have the latest versions of all of
the officially supported build steps
([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).
The Docker daemon will also have cached many of the layers for some popular
images, like "ubuntu", "debian", but they will be refreshed at the time you
attempt to use them.

If you built an image in a previous build step, it will be stored in the
host's Docker daemon's cache and is available to use as the name for a
later build step.

description:
The ID(s) of the step(s) that this build step depends on.
This build step will not start until all the build steps in `wait_for`
have completed successfully. If `wait_for` is empty, this build step will
start when all previous build steps in the `Build.Steps` list have
completed successfully.

description:
A list of environment variable definitions to be used when running a step.

The elements are of the form "KEY=VALUE" for the environment variable "KEY"
being given the value "VALUE".

description:
Entrypoint to be used instead of the build step image's default entrypoint.
If unset, the image's default entrypoint is used.

description:
List of volumes to mount into the build step.

Each volume is created as an empty volume prior to execution of the
build step. Upon completion of the build, volumes and their contents are
discarded.

Using a named volume in only one step is not valid as it is indicative
of a build request with an incorrect configuration.

$ref: #/definitions/Volume

description:
A list of arguments that will be presented to the step when it is started.

If the image used to run the step's container has an entrypoint, the `args`
are used as arguments to that entrypoint. If the image does not define
an entrypoint, the first element in args is used as the entrypoint,
and the remainder will be used as arguments.

description:
Time limit for executing this build step. If not defined, the step has no
time limit and will be allowed to continue to run until either it completes
or the build itself times out.

format: google-duration

description:
Unique identifier for this build step, used in `wait_for` to
reference this build step as a dependency.

description:
A list of environment variables which are encrypted using a Cloud Key
Management Service crypto key. These values must be specified in the
build's `Secret`.

description:
Working directory to use when running this step's container.

If this value is a relative path, it is relative to the build's working
directory. If this value is absolute, it may be outside the build's working
directory, in which case the contents of the path may not be persisted
across build step executions, unless a `volume` for that path is specified.

If the build specifies a `RepoSource` with `dir` and a step with a `dir`,
which specifies an absolute path, the `RepoSource` `dir` is ignored for
the step's execution.

description: Optional arguments to enable specific features of builds.

description: Compute Engine machine type on which to run the build.

enumDescriptions:
e2 HighCPU: 2 vCPUs, 2GB RAM
e2 HighCPU: 4 vCPUs, 4GB RAM
e2 HighCPU: 8 vCPUs, 8GB RAM
e2 HighCPU: 16 vCPUs, 16GB RAM
e2 HighCPU: 32 vCPUs, 32GB RAM
e2 HighMem: 2 vCPUs, 16GB RAM
e2 HighMem: 4 vCPUs, 32GB RAM
e2 HighMem: 8 vCPUs, 64GB RAM
e2 HighMem: 16 vCPUs, 128GB RAM
e2 Medium: 1 vCPU, 4GB RAM
e2 Standard: 2 vCPU, 8GB RAM
e2 Standard: 4 vCPU, 16GB RAM
e2 Standard: 8 vCPU, 32GB RAM
e2 Standard: 16 vCPU, 64GB RAM
e2 Standard: 32 vCPU, 128GB RAM
n1 HighCPU: 8 vCPUs, 7.2GB RAM
n1 HighCPU: 32 vCPUs, 28.8GB RAM
e2 Medium: 1 vCPU, 4GB RAM

description:
Global list of volumes to mount for ALL build steps

Each volume is created as an empty volume prior to starting the build
process. Upon completion of the build, volumes and their contents are
discarded. Global volume names and paths cannot conflict with the volumes
defined a build step.

Using a global volume in a build with only one step is not valid as
it is indicative of a build request with an incorrect configuration.

description:
Option to define build log streaming behavior to Google Cloud
Storage.

enumDescriptions: Service may automatically determine build log streaming behavior.

enumDescriptions: Build logs should be streamed to Google Cloud Storage.

enumDescriptions:
Build logs should not be streamed to Google Cloud Storage; they will be
written when the build is completed.

description:
Option to specify a `WorkerPool` for the build. User specifies the pool
with the format "[WORKERPOOL_PROJECT_ID]/[WORKERPOOL_NAME]".
This is an experimental field.

description:
A list of global environment variable definitions that will exist for all
build steps in this build. If a variable is defined in both globally and in
a build step, the variable will use the build step value.

The elements are of the form "KEY=VALUE" for the environment variable "KEY"
being given the value "VALUE".

description:
Option to specify the logging mode, which determines where the logs are
stored.

enumDescriptions:
The service determines the logging mode. The default is `LEGACY`. Do not
rely on the default logging behavior as it may change in the future.

enumDescriptions: Stackdriver logging and Cloud Storage logging are enabled.

enumDescriptions: Only Cloud Logging is enabled. Note that logs for both the Cloud Console UI and Cloud SDK are based on Cloud Storage logs, so neither will provide logs if this option is chosen.

enumDescriptions: Turn off all logging. No build logs will be captured.

description: Requested verifiability options.

enumDescriptions:
Not a verifiable build. (default)
Verified build.

description:
Option to specify behavior when there is an error in the substitution
checks.

enumDescriptions:
Fails the build if error in substitutions checks, like missing
a substitution in the template or in the map.

enumDescriptions: Do not fail the build if error in substitutions checks.

description:
Requested disk size for the VM that runs the build. Note that this is *NOT*
"disk free"; some of the space will be used by the operating system and
build utilities. Also note that this is the minimum disk size that will be
allocated for the build -- the build may run with a larger disk than
requested. At present, the maximum disk size is 1000GB; builds that request
more than the maximum are rejected with an error.

description:
A list of global environment variables, which are encrypted using a Cloud
Key Management Service crypto key. These values must be specified in the
build's `Secret`. These variables will be available to all build steps
in this build.

enumDescriptions:
No hash requested.
Use a sha256 hash.
Use a md5 hash.

description: Requested hash for SourceProvenance.

description:
Pairs a set of secret environment variables containing encrypted
values with the Cloud KMS key to use to decrypt the value.

description: Cloud KMS key name to use to decrypt these envs.

format: byte

description:
Map of environment variable name to its encrypted value.

Secret environment variables must be unique across all of a build's
secrets, and must be used by at least one build step. Values can be at most
64 KB in size. There can be at most 100 secret values across all of a
build's secrets.

description: Location of the source in a supported storage service.

description: If provided, get the source from this location in Google Cloud Storage.

$ref: #/definitions/StorageSource

description:
If provided, get the source from this location in a Cloud Source
Repository.

$ref: #/definitions/RepoSource

description: Location of the source in an archive file in Google Cloud Storage.

description:
Google Cloud Storage generation for the object. If the generation is
omitted, the latest generation will be used.

description:
Google Cloud Storage bucket containing the source (see
[Bucket Name
Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).

description:
Google Cloud Storage object containing the source.

This object must be a gzipped archive file (`.tar.gz`) containing source to
build.

$id: StorageSource

description: Location of the source in a Google Cloud Source Repository.

description: Name of the tag to build.

description:
ID of the project that owns the Cloud Source Repository. If omitted, the
project ID requesting the build is assumed.

description:
Name of the Cloud Source Repository. If omitted, the name "default" is
assumed.

description: Explicit commit SHA to build.

description:
Directory, relative to the source root, in which to run the build.

This must be a relative path. If a step's `dir` is specified and is an
absolute path, this value is ignored for that step's execution.

description: Name of the branch to build.

description:
Artifacts produced by a build that should be uploaded upon
successful completion of all build steps.

description:
A list of objects to be uploaded to Cloud Storage upon successful
completion of all build steps.

Files in the workspace matching specified paths globs will be uploaded to
the specified Cloud Storage location using the builder service account's
credentials.

The location and generation of the uploaded objects will be stored in the
Build resource's results field.

If any objects fail to be pushed, the build is marked FAILURE.

$ref: #/definitions/ArtifactObjects

description:
A list of images to be pushed upon the successful completion of all build
steps.

The images will be pushed using the builder service account's credentials.

The digests of the pushed images will be stored in the Build resource's
results field.

If any of the images fail to be pushed, the build is marked FAILURE.

description:
Files in the workspace to upload to Cloud Storage upon successful
completion of all build steps.

description:
Cloud Storage bucket and optional object path, in the form
"gs://bucket/path/to/somewhere/". (see [Bucket Name
Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).

Files in the workspace matching any path pattern will be uploaded to
Cloud Storage with this location as a prefix.

description: Path globs used to match files in the build's workspace.

description:
Volume describes a Docker container volume which is mounted into build steps
in order to persist files across build step execution.

description:
Name of the volume to mount.

Volume names must be unique per build step and must be valid names for
Docker volumes. Each named volume must be used by at least two build steps.

description:
Path at which to mount the volume.

Paths must be absolute and cannot conflict with other volume paths on the
same build step or with certain reserved volume paths.

description:
A build resource in the Cloud Build API.

At a high level, a `Build` describes where to find source code, how to build
it (for example, the builder image to run on the source), and where to store
the built artifacts.

Fields can include the following variables, which will be expanded when the
build is created:

- $PROJECT_ID: the project ID of the build.
- $BUILD_ID: the autogenerated ID of the build.
- $REPO_NAME: the source repository name specified by RepoSource.
- $BRANCH_NAME: the branch name specified by RepoSource.
- $TAG_NAME: the tag name specified by RepoSource.
- $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
  resolved from the specified branch or tag.
- $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.

$ref: #/definitions/BuildStep

description: Required. The operations to be performed on the workspace.

description:
Google Cloud Storage bucket where logs should be written (see
[Bucket Name
Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.

description: Tags for annotation of a `Build`. These are not docker tags.

description: Substitutions data for `Build` resource.

description:
A list of images to be pushed upon the successful completion of all build
steps.

The images are pushed using the builder service account's credentials.

The digests of the pushed images will be stored in the `Build` resource's
results field.

If any of the images fail to be pushed, the build status is marked
`FAILURE`.

$ref: #/definitions/BuildOptions

description: Special options for this build.

$ref: #/definitions/Source

description: The location of the source files to build.

$ref: #/definitions/Artifacts

description:
Artifacts produced by the build that should be uploaded upon
successful completion of all build steps.

description:
Amount of time that this build should be allowed to run, to second
granularity. If this amount of time elapses, work on the build will cease
and the build status will be `TIMEOUT`.

Default time is ten minutes.

description: Secrets to decrypt using Cloud Key Management Service.

$ref: #/definitions/Secret

description: Use this field to specify the IAM service account to use at build time.

pattern: ^projects/\w+/serviceAccounts/\w+$

title: Google Cloud Build build config file


vsext.json

description: A unique identifier for the extension pack. This is to uniquely identify the extension pack and will not be shown to the user.

description: The name of the extension pack.

description: A short description of the extension pack.

description: The version of the extension pack.

description: A list of extension objects.

description: The name of the extension.

description: The unique ID of the extension.

title: JSON schema for Visual Studio extension pack manifests


tmuxinator.json

description: Name of project root (deprecated, use `name`)

description: Name of project root (deprecated, use `root`)

description: Optional tmux socket.

description: Runs on project start, always.

description: Run on project start, the first time.

description: Run on project start, after the first time.

description: Run on project exit (detaching from tmux session).

description: Run on project stop.

description: Runs before everything (deprecated).

description: Runs after everything (deprecated).

description: Specify version for rbenv (deprecated)

description: Pass arguments to tmux (deprecated)

description: Specify tabs (deprecated)

description: Runs in each window and pane before window/pane specific commands. Useful for setting up interpreter versions.

description: Pass command line options to tmux. Useful for specifying a different tmux.conf.

description: Change the command to call tmux.  This can be used by derivatives/wrappers like byobu.

description: Specifies (by name or index) which window will be selected on project startup. If not set, the first window is used.

description: Specifies (by index) which pane of the specified window will be selected on project startup. If not set, the first pane is used.

description: Controls whether the tmux session should be attached to automatically. Defaults to true.

description: Deprecated. Use `attach`

description: The layout setting gets handed down to tmux directly, so you can choose from one of the five tmux standard layouts or specify your own.

description: Panes are optional and are children of window entries.


stripe-app.schema.json

title: Stripe App manifest

description: A manifest describing a Stripe App.

required: id version name icon permissions ui_extension

description: The unique identifier for an app, for example "com.invoicing.myapp".

markdownDescription: The unique identifier for an app, for example `com.invoicing.myapp`.

description: An app version that you define. You can use any format you want for version identifiers.

description: The name shown in the UI when referring to your app.

description: The relative path to a 300x300 pixel PNG image, for example "./icon.png".

markdownDescription: The relative path to a 300x300 pixel PNG image, for example `./icon.png`.

description: The permissions available to the app. Read more about permissions: https://stripe.com/docs/stripe-apps/reference/permissions

markdownDescription: The permissions available to the app. [Read more about permissions](https://stripe.com/docs/stripe-apps/reference/permissions).

description: The ID of the permission. Read more about permissions: https://stripe.com/docs/stripe-apps/reference/permissions

markdownDescription: The ID of the permission. [Read more about permissions](https://stripe.com/docs/stripe-apps/reference/permissions).

description: The reason for requesting the permission.

required: permission purpose

description: Specify a recommended action for users to take after installing your app. Read more about post-install actions: https://stripe.com/docs/stripe-apps/post-install-actions

markdownDescription: Specify a recommended action users should take after installing your app. [Read more about post-install actions](https://stripe.com/docs/stripe-apps/post-install-actions).

$ref: #/$defs/postInstallActionType

const: settings

required: type url

const: external

description: External URL to redirect users to after installing your app.

format: uri

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

description: Configure where the app appears in the Dashboard.

required: viewport component

description: An identifier that indicates where a UI extension appears in the Dashboard. Read more about viewports: https://stripe.com/docs/stripe-apps/reference/viewports

markdownDescription: An identifier that indicates where a UI extension appears in the Dashboard. [Read more about viewports](https://stripe.com/docs/stripe-apps/reference/viewports).

description: The name of the React component in the "src/views" directory to render.

markdownDescription: The name of the React component in the `src/views` directory to render.

description: Configure the content security policy for your app.

description: URLs of permitted third-party APIs. If the URL ends in a slash, all of its children also receive permission. Read about using third-party APIs: https://stripe.com/docs/stripe-apps/build-ui#use-third-party-apis

markdownDescription: URLs of permitted third-party APIs. If the URL ends in a slash, all of its children also receive permission. [Read about using third-party APIs](https://stripe.com/docs/stripe-apps/build-ui#use-third-party-apis).

description: URLs the Img component (https://stripe.com/stripe-apps/ui-toolkit/components/img) can load from. If the URL ends in a slash, all trailing paths are also permitted.

markdownDescription: URLs the [Img component](https://stripe.com/stripe-apps/ui-toolkit/components/img) can load from. If the URL ends in a slash, all trailing paths are also permitted.

description: A message to show users when the app is installed that explains why the app needs to communicate with external URLs.

description: Custom values that are passed through to your views via context props. Read about context props: https://stripe.com/docs/stripe-apps/reference/extensions-sdk-api#props

markdownDescription: Custom values that are passed through to your views via context props. [Read about context props](https://stripe.com/docs/stripe-apps/reference/extensions-sdk-api#props).

description: A list of allowed urls to which the user can be redirected upon successful install of this app. Read about using allowed redirect urls: https://stripe.com/docs/stripe-apps/reference/app-manifest#allowed-redirect-urls

markdownDescription: A list of allowed urls to which the user can be redirected upon successful install of this app. [Read about using allowed redirect urls](https://stripe.com/docs/stripe-apps/reference/app-manifest#allowed-redirect-urls).

description: The recommended action for users to take after installing your app. Read about post-install actions: https://stripe.com/docs/stripe-apps/post-install-actions

markdownDescription: The recommended action for users to take after installing your app. [Read about post-install actions](https://stripe.com/docs/stripe-apps/post-install-actions).


machine.schema.json

definition: The action type

enum: atomic compound parallel final history

$ref: #/definitions/order

description: The description of the state node, in Markdown

required: id key type

$ref: #/definitions/baseStateNode

pattern: compound

$ref: #/definitions/actionObject

$ref: #/definitions/invokeArray

$ref: #/definitions/transitionsObject

$ref: #/definitions/statesObject

pattern: parallel

pattern: atomic

pattern: history

enum: shallow deep

pattern: final

$ref: #/definitions/atomicStateNode

$ref: #/definitions/compoundStateNode

$ref: #/definitions/parallelStateNode

$ref: #/definitions/historyStateNode

$ref: #/definitions/finalStateNode

$ref: #/definitions/transitionObject

required: actions eventType source target

required: type id src

$ref: #/definitions/invokeObject

title: ID

enum: compound parallel


drush.site.yml.json

title: The Drupal root for this site

title: The fully-qualified domain name of the remote system hosting the Drupal instance

title: Site URI

description: The value of uri should always be the same as when the site is being accessed from a web browser

title: The username to log in as when using ssh or rsync

title: The operating system of the remote server

enum: Windows Linux

title: Contains settings used to control how ssh commands are generated when running remote commands

title: Additional commandline options for the ssh command itself

title: A flag to force Drush to always or never create a tty

title: Aliases for common rsync targets

title: Path to the remote Drush command

title: A list of paths where Drush will search for alias files

titles: Path to 'files' directory

title: Contains options for specific commands

title: The name of the container to run on

title: Options for exec command

title: Vagrant transport

title: JSON Schema for Drush site aliases


sigrid-scope-file.schema.json

enum: week month

$ref: #/definitions/component

$ref: #/definitions/language

required: source target

$ref: #/definitions/dependency

required: name include

description: Analysis scope configuration file used by Sigrid (sigrid-says.com)

description: When true, excludes files and directories from the analysis scope based on common conventions.

description: List of file and directory patterns to manually exclude from the analysis.

description: Directory depth that will be used to define components.

description: A list of technologies that should be included as part of the analysis.

$ref: #/definitions/model

description: Version of the SIG quality model that should be used for the analysis.

description: When true, will send alert email notifications when noteworthy events happen.

format: email

description: List of email addresses that should receive alerts.

description: When this *or* the 'blocklist' option is provided, OSH analysis is performed for every upload.

description: List of patterns for library names that should not be sent to external services.

description: Deprecated, use 'blocklist' instead.

description: When true, transitive dependencies are also checked and included in the results.

description: List of file/directory patterns that should be excluded from the Open Source Health analysis.

description: Indicates that this system should be scanned for vulnerabilities using Checkmarx.

description: Unique ID to identify the Checkmarx project.

description: Your Checkmarx username.

required: enabled id

description: When true, architecture analysis will be triggered for each incoming upload.

description: Version of the SIG Architecture Quality Model to use.

description: List of exclude patterns that applies only to Architecture Quality, not globally.

description: Overrides automatic component detection with components defined manually in scope file.

description: List of directory names that should be flattened and not considered as components during the analysis.

description: List of manually added dependencies on top of the ones detected automatically by the analysis.

description: List of dependencies that manually overrides the analysis and removes them from the results.

description: List of dependencies considered undesirable, and should therefore be highlighted in the visualization.

description: Map of system elements for which to manually override the name.

description: Default is false. When true, skips automated data store detection and assumes one monolithic data store.

description: Annotate all top-level components matching the pattern, in order to divide them into logical groups.

description: Disables change history analysis when set to false.

description: Deprecated, use 'history_enabled' instead.

description: Period to use for repository history analysis, default is last 12 months.

$ref: #/definitions/yyyymmdd

description: Repository history start date in the format 'yyyy-mm-dd', default is last year.

description: Repository history end date in the format 'yyyy-mm-dd', default is current date.

$ref: #/definitions/interval

description: Either 'week' (default) or ‘month’.

description: Filters commits with an abnormally large amount of churn from the history analysis.

$ref: #/definitions/branches

description: Repository branch to use, comma-separated for multiple branches. Defaults to current branch.

description: Set to false to disable duplication detection, improves performance for huge systems.

description: Set to false to disable co-evolution detection, improves performance for huge systems.

description: List of metrics that should be removed from the analysis and set to N/A.

description: When true, third party findings analysis will be triggered for each incoming upload.

description: List of third-party analyzers that should not be ran.

description: List of third-party analyzer names that should be ran even though they are disabled by default.

description: List of file/directory patterns that should be included in the third party findings analysis beyond the maintainability scope and production configuration files.

description: List of file/directory patterns that should be excluded from the third party findings analysis.

title: Sigrid scope configuration file


pull-request-labeler.json

title: Label

type: string array

title: Any

title: All

description: A GitHub Action for automatically labelling pull requests.

title: Pull Request Labeler