schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
asmdef.json
overrideReferences
When true, any references to precompiled assembly assets are manually chosen. When false, all precompiled assembly assets are automatically referenced
{"type": "boolean", "default": "false"}
asmdef.json
precompiledReferences
A list of precompiled assembly assets that will be referenced. Only valid when overrideReferences is true
{"type": "array", "uniqueItems": true}
asmdef.json
defineConstraints
A list of the C# compiler define symbols that must evaluate to true in order for the assembly to be compiled or referenced. Absence of a symbol can be checked with a bang symbol (!DEFINE)
{"type": "array", "uniqueItems": true}
asmdef.json
optionalUnityReferences
Additional optional Unity features to reference
{"type": "array", "items": {"enum": ["TestAssemblies"]}, "uniqueItems": true}
asmdef.json
versionDefines
A set of expressions that will define a symbol in the C# project if a package or module version matches the given expression
{"type": "array", "uniqueItems": true, "items": {"type": "object", "properties": {"name": {"type": "string"}, "expression": {"type": "string"}, "define": {"type": "string"}}, "required": ["name", "expression", "define"]}}
asmdef.json
name
The package or module that will provide the version to be checked in the expression
{"type": "string"}
asmdef.json
expression
The semantic version range of the chosen package or module
{"type": "string"}
asmdef.json
define
The name of the define that is added to the project file when expression evaluates to true
{"type": "string"}
dependabot.json
package_manager
What package manager to use
{"type": "string", "enum": ["javascript", "ruby:bundler", "php:composer", "python", "go:modules", "go:dep", "java:maven", "java:gradle", "dotnet:nuget", "rust:cargo", "elixir:hex", "docker", "terraform", "submodules", "elm", "github_actions"], "examples": ["ruby:bundler"]}
dependabot.json
directory
Where to look for package manifests
{"type": "string", "examples": ["/app"]}
dependabot.json
update_schedule
How often to check for updates
{"type": "string", "enum": ["live", "daily", "weekly", "monthly"], "examples": ["live"]}
dependabot.json
target_branch
Branch to create pull requests against. By default your repository's default branch is used.
{"type": "string", "items": {"type": "string", "examples": ["develop"]}}
dependabot.json
items
branchname
{"type": "string", "examples": ["develop"]}
dependabot.json
default_reviewers
Reviewers to set on update pull requests.
{"type": "array", "items": {"type": "string", "examples": ["github-username"]}}
dependabot.json
items
reviewer github username
{"type": "string", "examples": ["github-username"]}
dependabot.json
default_assignees
Assignees to set on update pull requests.
{"type": "array", "items": {"type": "string", "examples": ["github_username_1"]}}
dependabot.json
items
assignee github username
{"type": "string", "examples": ["github_username_1"]}
dependabot.json
default_labels
Labels to set on update pull requests. By default 'dependencies' is used.
{"type": "array", "items": {"type": "string", "examples": ["label-name"]}}
dependabot.json
default_milestone
Milestone to set on dependency update pull requests. Specified using the milestone number - you can find this in the URL when looking at details of a milestone in GitHub.
{"type": "integer"}
dependabot.json
allowed_updates
Limit which updates are allowed. By default all direct/top-level dependencies are kept up to date (indirect/sub-dependencies are only updated if they include security fixes).
{"type": "array", "items": {"type": "object", "minItems": 1, "properties": {"match": {"type": "object", "properties": {"dependency_name": {"type": "string", "examples": ["react*"]}, "dependency_type": {"type": "string", "examples": ["development", "production", "direct", "indirect", "all"]}, "update_type": {"type": "st...
dependabot.json
dependency_name
matching on dependency name
{"type": "string", "examples": ["react*"]}
dependabot.json
dependency_type
only allow certain updates
{"type": "string", "examples": ["development", "production", "direct", "indirect", "all"]}
dependabot.json
update_type
which updates to do
{"type": "string", "enum": ["security", "all"], "default": "security", "examples": ["all"]}
dependabot.json
ignored_updates
By default no updates are ignored. The version_requirement specifies the versions to ignore. The range format is specific to the package manager (e.g., ^1.0.0 for JS, or ~> 2.0 for Ruby).
{"type": "array", "items": {"type": "object", "minItems": 1, "properties": {"match": {"type": "object", "properties": {"dependency_name": {"type": "string", "examples": ["aws*"]}, "version_requirement": {"type": "string", "examples": ["4.x"]}}}}}}
dependabot.json
dependency_name
matching on dependency name
{"type": "string", "examples": ["aws*"]}
dependabot.json
version_requirement
The version_requirement specifies the versions to ignore. The range format is specific to the package manager (e.g., ^1.0.0 for JS, or ~> 2.0 for Ruby).
{"type": "string", "examples": ["4.x"]}
dependabot.json
automerged_updates
Automerged updates must be enabled at the account level (from account settings in your dashboard) before they can be configured on a project. Specify which update pull requests should be merged automatically. By default no updates are automerged. For all of the options below Dependabot will wait until all your status c...
{"type": "array", "items": {"type": "object", "minItems": 1, "properties": {"match": {"type": "object", "properties": {"dependency_name": {"type": "string", "examples": ["aws*"]}, "dependency_type": {"type": "string", "enum": ["development", "production", "all"], "examples": ["production*"]}, "update_type": {"type": "s...
dependabot.json
dependency_name
matching on dependency name
{"type": "string", "examples": ["aws*"]}
dependabot.json
version_requirement_updates
Specify how Dependabot should update your package manifest (e.g. package.json, Gemfile etc), as opposed to your lockfile. By default, version requirements are increased if it's an app and the range widened if it's a library.
{"type": "string", "enum": ["off", "auto", "widen_ranges", "increase_versions", "increase_versions_if_necessary"], "examples": ["widen_ranges"]}
dependabot.json
commit_message
Preferences for the format of Dependabot's commit messages and pull request titles. By default, Dependabot will attempt to detect your commit message preferences and use those.
{"type": "object", "properties": {"prefix": {"type": "string", "examples": ["chore"]}, "prefix_development": {"type": "string", "examples": ["fix"]}, "include_scope": {"type": "boolean"}}}
collection_schema.json
tags
List of tags.
{"items": {"type": "string"}, "type": "array"}
collection_schema.json
name
The mandatory name of the node. If not present, node will be skipped at runtime. It is used for example in debug log to help you track things.
{"type": "string"}
collection_schema.json
items
List of parsers to include in the collection.
{"type": "string"}
collection_schema.json
items
List of scnearios to include in the collection.
{"type": "string"}
collection_schema.json
author
The name of the author.
{"type": "string"}
collection_schema.json
description
description of the parser usage
{"type": "string"}
collection_schema.json
items
List of collections to include in the collection.
{"type": "string"}
collection_schema.json
items
List of postoverflows to include in the collection.
{"type": "string"}
ize-spec.json
aws_profile
(optional) AWS Profile can be specified here (but normally it's specified via AWS_PROFILE env var)
{"type": "string"}
ize-spec.json
aws_region
(required) AWS Region of this environment should be specified here. Can be overridden by AWS_PROFILE env var or --aws-region flag.
{"type": "string"}
ize-spec.json
config_file
(optional) Path to ize.toml config file can be specified, but normally it's read from the environment's directory automatically.
{"type": "string"}
ize-spec.json
env
(optional) Environment name can be specified here. Normally it should be passed via `ENV` variable or --env flag.
{"type": "string"}
ize-spec.json
env_dir
(optional) Environment directory can be specified here. Normally it's calculated automatically based on the directory structure convention.
{"type": "string"}
ize-spec.json
home
(optional) User home directory can be specified here. Normally $HOME is used.
{"type": "string"}
ize-spec.json
ize_dir
(optional) Ize directory can be specified here. Normally it's assumed to be .infra or .ize in the current repo.
{"type": "string"}
ize-spec.json
log_level
(optional) Log level can be specified here. Possible levels: info, debug, trace, panic, warn, error, fatal(default). Can be overridden via IZE_LOG_LEVEL env var or via --log-level flag.
{"type": "string"}
ize-spec.json
namespace
(required) Namespace of the project can be specified here. It is used as a base for all naming. It can be overridden by NAMESPACE env var or --namespace flag.
{"type": "string"}
ize-spec.json
plain_text
(optional) Plain text output can be enabled here. Default is false. Can be overridden by IZE_PLAIN_TEXT env var or --plain-text flag.
{"anyOf": [{"type": "string"}, {"type": "boolean"}]}
ize-spec.json
prefer_runtime
(optional) Prefer a specific runtime. (native or docker) (default 'native')
{"type": "string"}
ize-spec.json
apps_path
(optional) Path to apps directory can be set. By default apps are searched in 'apps' and 'projects' directories. This is needed in case your repo structure is not purely ize-structured (let's say you have 'src' repo in your dotnet app, as an example)
{"type": "string"}
ize-spec.json
root_dir
(optional) Project directory can be set here. By default it's the current directory, but in case you prefer to run ize from the outside of repo it may be useful (uncommon).
{"type": "string"}
ize-spec.json
terraform_version
(optional) Terraform version can be set here. 1.1.3 by default
{"type": "string"}
ize-spec.json
docker_registry
(optional) Docker registry can be set here. By default it uses ECR repo with the name of the service.
{"type": "string"}
ize-spec.json
tf_log_path
(optional) TF_LOG_PATH can be set here.
{"type": "string"}
ize-spec.json
tag
(optional) Tag can be set statically. Normally it is being constructed automatically based on the git revision.
{"type": "string"}
ize-spec.json
tf_log
(optional) Terraform TF_LOG can be set here. Can be TRACE, DEBUG, INFO, WARN or ERROR.
{"type": "string"}
ize-spec.json
custom_prompt
(optional) Custom prompt can be enabled here for all console connections. Default: false.
{"anyOf": [{"type": "string"}, {"type": "boolean"}]}
ize-spec.json
tunnel
Tunnel configuration.
{"type": "object", "properties": {"bastion_instance_id": {"type": "string"}, "forward_host": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false}
ize-spec.json
bastion_instance_id
Bastion instance ID.
{"type": "string"}
ize-spec.json
items
Forward host.
{"type": "string"}
ize-spec.json
app
Apps configuration.
{"deprecationMessage": "app block is deprecated", "id": "#/properties/app", "type": "object", "patternProperties": {"^[a-zA-Z0-9._-]+$": {}}, "additionalProperties": false}
ize-spec.json
ecs
Ecs apps configuration.
{"id": "#/properties/ecs", "type": "object", "patternProperties": {"^[a-zA-Z0-9._-]+$": {}}, "additionalProperties": false}
ize-spec.json
serverless
Serverless apps configuration.
{"id": "#/properties/serverless", "type": "object", "patternProperties": {"^[a-zA-Z0-9._-]+$": {}}, "additionalProperties": false}
ize-spec.json
alias
(optional) Alias mode can be enabled here. This can be used to combine various apps via depends_on parameter.
{"id": "#/properties/alias", "type": "object", "patternProperties": {"^[a-zA-Z0-9._-]+$": {}}, "additionalProperties": false}
ize-spec.json
terraform
Terraform configuration.
{"id": "#/properties/terraform", "type": "object", "patternProperties": {"^[a-zA-Z0-9._-]+$": {}}, "additionalProperties": false}
ize-spec.json
infra
Infrastructure configuration.
{"type": "object", "deprecationMessage": "infra block is deprecated", "properties": {"terraform": {"type": "object", "properties": {"version": {"type": "string"}, "terraform_version": {"type": "string"}, "state_bucket_region": {"type": "string"}, "state_bucket_name": {"type": "string"}, "state_name": {"type": "string"}...
ize-spec.json
terraform
Infrastructure configuration.
{"type": "object", "properties": {"version": {"type": "string"}, "terraform_version": {"type": "string"}, "state_bucket_region": {"type": "string"}, "state_bucket_name": {"type": "string"}, "state_name": {"type": "string"}, "root_domain_name": {"type": "string"}, "aws_region": {"type": "string"}, "aws_profile": {"type"...
ize-spec.json
version
(optional) Terraform version can be set here. 1.1.3 by default.
{"type": "string"}
ize-spec.json
state_bucket_region
(optional) Terraform state bucket region can be specified here. Normally AWS_REGION is used here. Can be overridden via env vars or flags.
{"type": "string"}
ize-spec.json
state_bucket_name
(optional) Terraform state bucket name can be specified here. Normally it's generated and defaults to <NAMESPACE>-tf-state
{"type": "string"}
ize-spec.json
state_name
(optional) Terraform state name that will be used in the .tfstate file. Normally it's 'terraform' or state name.
{"type": "string"}
ize-spec.json
root_domain_name
(optional) Root domain name can be set here. This is the main domain that will be passed to the terraform. Generally if your app lives at 'api.dev.nutcorp.net' the root domain is `nutcorp.net`
{"type": "string"}
ize-spec.json
aws_region
(optional) Terraform-specific AWS Region of this environment should be specified here. Normally global AWS_REGION is used.
{"type": "string"}
ize-spec.json
aws_profile
(optional) Terraform-specific AWS profile (optional) can be specified here (but normally it should be inherited from a global AWS_PROFILE).
{"type": "string"}
ize-spec.json
tunnel
Tunnel configuration.
{"type": "object", "properties": {"bastion_instance_id": {"type": "string"}, "forward_host": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false}
ize-spec.json
bastion_instance_id
Bastion instance ID.
{"type": "string"}
ize-spec.json
items
Forward host.
{"type": "string"}
ize-spec.json
app
App configuration.
{"deprecationMessage": "app block is deprecated", "id": "#/definitions/app", "type": "object", "properties": {"type": {"type": "string"}, "file": {"type": "string"}, "node_version": {"type": "string"}, "create_domain": {"type": "boolean"}, "path": {"type": "string"}, "sls_node_modules_cache_mount": {"type": "string"}, ...
ize-spec.json
type
app type
{"type": "string"}
ize-spec.json
file
(optional) Path to serverless file can be specified here. Normally it's serverless.yml in the app directory.
{"type": "string"}
ize-spec.json
node_version
(optional) Node version that will be used by nvm can be specified here that. Default is v14.
{"type": "string"}
ize-spec.json
create_domain
(optional) Create domain for the serverless domain manager during the deployment.
{"type": "boolean"}
ize-spec.json
path
(optional) Path to ecs app folder can be specified here. By default it's derived from apps path and app name.
{"type": "string"}
ize-spec.json
sls_node_modules_cache_mount
(optional) SLS node_modules cache mount path can be specified here. It's used to store cache during CI/CD process.
{"type": "string"}
ize-spec.json
env
environments
{"type": "array", "items": {"type": "string"}}
ize-spec.json
items
environment
{"type": "string"}
ize-spec.json
unsafe
(optional) Enables unsafe mode that increases deploy time on a cost of shorter healthcheck.
{"type": "boolean"}
ize-spec.json
image
(optional) Docker image can be specified here. By default it's derived from the app name.
{"type": "string"}
ize-spec.json
cluster
(optional) ECS cluster can be specified here. By default it's derived from env & namespace
{"type": "string"}
ize-spec.json
task_definition_revision
(optional) Task definition revision can be specified here. By default latest revision is used to perform a deployment. Normally this parameter can be used via cli during specific deployment needs.
{"type": "string"}
ize-spec.json
timeout
(optional) ECS deployment timeout can be specified here.
{"type": "integer"}
ize-spec.json
docker_registry
(optional) Docker registry can be set here. By default it uses ECR repo with the name of the service.
{"type": "string"}
ize-spec.json
skip_deploy
(optional) skip deploy app.
{"type": "boolean"}
ize-spec.json
depends_on
(optional) expresses startup and shutdown dependencies between apps
{"type": "array"}
ize-spec.json
ecs
Ecs app configuration.
{"id": "#/definitions/ecs", "type": "object", "properties": {"path": {"type": "string"}, "unsafe": {"type": "boolean"}, "image": {"type": "string"}, "cluster": {"type": "string"}, "task_definition_revision": {"type": "string"}, "timeout": {"type": "integer"}, "docker_registry": {"type": "string"}, "skip_deploy": {"type...
ize-spec.json
path
(optional) Path to ecs app folder can be specified here. By default it's derived from apps path and app name.
{"type": "string"}
ize-spec.json
unsafe
(optional) Enables unsafe mode that increases deploy time on a cost of shorter healthcheck.
{"type": "boolean"}
ize-spec.json
image
(optional) Docker image can be specified here. By default it's derived from the app name.
{"type": "string"}
ize-spec.json
cluster
(optional) ECS cluster can be specified here. By default it's derived from env & namespace
{"type": "string"}
ize-spec.json
task_definition_revision
(optional) Task definition revision can be specified here. By default latest revision is used to perform a deployment. Normally this parameter can be used via cli during specific deployment needs.
{"type": "string"}